CodiMD container

Debian based version:

Main docker image based on Debian and used by default in the docker-compose.yml. Recommended for test and production deployments.

Alpine based version:

Minimal docker image based on Alpine can be used for expert setups. In order to prevent crashes due to dependency problems, this version comes without PDF export.

Prerequisite

• git (https://git-scm.com/⁠)
• docker (https://www.docker.com/community-edition⁠)
• docker-compose (https://docs.docker.com/compose/install/⁠)

See more here: https://docs.docker.com/⁠

Usage

Get started

1. Install docker and docker-compose, "Docker for Windows" or "Docker for Mac"
2. Run git clone https://github.com/codimd/container.git codimd-container
3. Change to the directory codimd-container directory
4. Run docker-compose up in your terminal
5. Wait until see the log HTTP Server listening at port 3000, it will take few minutes based on your internet connection.
6. Open http://127.0.0.1:3000⁠

Update

Start your docker and enter the terminal, follow below commands:

cd codimd-container ## enter the directory
git pull ## pull new commits
docker-compose pull ## pull new containers
docker-compose up ## turn on

Migrate from docker-hackmd

If you used the docker-hackmd⁠ repository before, migrating to codimd-container⁠ is easy.

Since codimd-container is basically a fork of docker-hackmd, all you need to do is replacing the upstream URL.

git remote set-url origin https://github.com/codimd/container.git
git pull

Now you can follow the regular update steps.

migration-to-0.5.0⁠

We don't use LZString to compress socket.io data and DB data after version 0.5.0. Please run the migration tool if you're upgrading from the old version.

1. Stop your CodiMD containers
2. Modify docker-compose.yml, add expose ports 5432 to hackmdPostgres
3. docker-compose up to start your codimd containers
4. Backup DB (see below)
5. Git clone above migration-to-0.5.0 and npm install (see more on above link)
6. Modify config.json in migration-to-0.5.0, change its username, password and host to your docker
7. Run migration (see more on above link)
8. Stop your codimd containers
9. Modify docker-compose.yml, remove expose ports 5432 in hackmdPostgres
10. git pull in codimd-container, update to version 0.5.0 (see below)

Backup

Start your docker and enter the terminal, follow below commands:

 docker-compose exec database pg_dump hackmd -U hackmd  > backup.sql

Restore

Similar to backup steps, but last command is

cat backup.sql | docker exec -i $(docker-compose ps -q database) psql -U hackmd

Kubernetes

To install use helm install stable/hackmd.

For all further details, please check out the offical HackMD K8s helm chart⁠.

Custom build

The default setting would use pre-build docker image, if you want to build your own containers uncomment the build section in the docker-compose.yml⁠ and edit the config.json⁠.

If you change the database settings and don't use the HMD_DB_URL make sure you edit the .sequelizerc⁠.

License

View license information⁠ for the software contained in this image.

Supported Docker versions

This image is officially supported on Docker version 17.03.1-CE.

Support for older versions (down to 1.12) is provided on a best-effort basis.

Please see the Docker installation documentation⁠ for details on how to upgrade your Docker daemon.

User Feedback

Issues

If you have any problems with or questions about this image, please contact us through a GitHub issue⁠.

You can also reach many of the project maintainers via our #codimd:matrix.org⁠.

Contributing

You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.

Happy CodiMD :smile: