hedgedoc / Container
Programming Languages
Projects that are alternatives of or similar to Container
HedgeDoc container
HedgeDoc docker images are available in two flavors: Debian and Alpine. These are available at quay.io:
https://quay.io/repository/hedgedoc/hedgedoc
docker pull quay.io/hedgedoc/hedgedoc:1.7.2-debian
docker pull quay.io/hedgedoc/hedgedoc:1.7.2-alpine
We recommend using the Debian version for production deployments and Alpine for expert setups.
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
- Install docker and docker-compose, "Docker for Windows" or "Docker for Mac"
- Run
git clone https://github.com/hedgedoc/container.git hedgedoc-container
- Change to the directory
hedgedoc-container
directory - Run
docker-compose up
in your terminal - Wait until see the log
HTTP Server listening at port 3000
, it will take few minutes based on your internet connection. - Open http://127.0.0.1:3000
Update
Start your docker and enter the terminal, follow below commands:
cd hedgedoc-container ## enter the directory
git pull ## pull new commits
docker-compose pull ## pull new containers
docker-compose up ## turn on
Configuration
You can configure your container with a config file or with env vars. Check out https://docs.hedgedoc.org/configuration/ for more details.
Migrate from 1.6
Together with the update to HedgeDoc 1.7, the database user name, password and database name have been changed in docker-compose.yml
.
In order to migrate the existing database to the new default credentials, run
docker-compose exec database createuser --superuser -Uhackmd postgres
docker-compose exec database psql -Upostgres -c "alter role hackmd rename to hedgedoc; alter role hedgedoc with password 'password'; alter database hackmd rename to hedgedoc;"
before running docker-compose up
.
Migrate from docker-hackmd
If you used the docker-hackmd
repository before, you can migrate to hedgedoc-container
.
hedgedoc-container
is fork of docker-hackmd
, so you need to replace the upstream URL:
git remote set-url origin https://github.com/hedgedoc/container.git
git pull
Since both codebases diverged since the fork, we recommend that you read the
HedgeDoc release notes at
least since 1.6.0 and follow any instructions present there. A particular issue
that has come up is when handling TLS connections when using a reverse proxy.
You must set the X-Forwarded-Proto
header
correctly.
Backup
Start your docker and enter the terminal, follow below commands:
docker-compose exec database pg_dump hedgedoc -U hedgedoc > backup.sql
Restore
Before starting the application for the first time, run these commands:
docker-compose up -d database
cat backup.sql | docker exec -i $(docker-compose ps -q database) psql -U hedgedoc
Custom build
The default setting is to use pre-built docker images. 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 CMD_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 matrix room
#hedgedoc: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 HedgeDoc 😄