{"id":13503224,"url":"https://github.com/hackmdio/docker-hackmd","last_synced_at":"2025-03-29T14:31:14.314Z","repository":{"id":94848061,"uuid":"43245218","full_name":"hackmdio/docker-hackmd","owner":"hackmdio","description":"DEPRECATION: Please read our online documentation instead","archived":true,"fork":true,"pushed_at":"2019-11-15T09:23:27.000Z","size":225,"stargazers_count":269,"open_issues_count":5,"forks_count":74,"subscribers_count":22,"default_branch":"master","last_synced_at":"2025-03-17T07:15:40.838Z","etag":null,"topics":["docker","docker-compose","hackmd"],"latest_commit_sha":null,"homepage":"https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-docker-deployment","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"a-r-g-v/docker-hackmd","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hackmdio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2015-09-27T12:10:25.000Z","updated_at":"2024-05-04T10:18:38.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/hackmdio/docker-hackmd","commit_stats":{"total_commits":126,"total_committers":13,"mean_commits":9.692307692307692,"dds":0.5555555555555556,"last_synced_commit":"d73d1047b19c69349c60dd3af7fc429da750c714"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmdio%2Fdocker-hackmd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmdio%2Fdocker-hackmd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmdio%2Fdocker-hackmd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmdio%2Fdocker-hackmd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hackmdio","download_url":"https://codeload.github.com/hackmdio/docker-hackmd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244460332,"owners_count":20456302,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","hackmd"],"created_at":"2024-07-31T22:02:42.545Z","updated_at":"2025-03-29T14:31:14.279Z","avatar_url":"https://github.com/hackmdio.png","language":"Shell","readme":"docker-hackmd (DEPRECATED)\n===\n\n\u003ch1 style=\"color: red;\"\u003e!!!Warning!!!\u003c/h1\u003e\n\nThis repository has been deprecated. Please use our online documentation instead:\n\n[https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-docker-deployment](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-docker-deployment)\n\n---\n\n[![Build Status](https://travis-ci.org/hackmdio/docker-hackmd.svg?branch=master)](https://travis-ci.org/hackmdio/docker-hackmd)\n[![Gitter](https://badges.gitter.im/hackmdio/hackmd.svg)](https://gitter.im/hackmdio/hackmd?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge)\n[![Try in PWD](https://cdn.rawgit.com/play-with-docker/stacks/cff22438/assets/images/button.png)](http://play-with-docker.com?stack=https://github.com/hackmdio/docker-hackmd/raw/master/docker-compose.yml\u0026stack_name=hackmd)\n\n**Debian based version:**\n\n[![](https://images.microbadger.com/badges/version/hackmdio/hackmd:latest.svg)](https://microbadger.com/images/hackmdio/hackmd \"Get your own version badge on microbadger.com\") [![](https://images.microbadger.com/badges/image/hackmdio/hackmd:latest.svg)](https://microbadger.com/images/hackmdio/hackmd \"Get your own image badge on microbadger.com\")\n\n\n**Alpine based version:**\n\n[![](https://images.microbadger.com/badges/version/hackmdio/hackmd:alpine.svg)](https://microbadger.com/images/hackmdio/hackmd:alpine \"Get your own version badge on microbadger.com\") [![](https://images.microbadger.com/badges/image/hackmdio/hackmd:alpine.svg)](https://microbadger.com/images/hackmdio/hackmd:alpine \"Get your own image badge on microbadger.com\")\n\n\n# Prerequisite\n* git (https://git-scm.com/)\n* docker (https://www.docker.com/community-edition)\n* docker-compose (https://docs.docker.com/compose/install/)\n\nSee more here: https://docs.docker.com/\n\n\n# Usage\n\n## Get started\n\n1. Install docker and docker-compose, \"Docker for Windows\" or \"Docker for Mac\"\n2. Run `git clone https://github.com/hackmdio/docker-hackmd.git`\n3. Change to the directory `docker-hackmd` directory\n4. Run `docker-compose up` in your terminal\n5. Wait until see the log `HTTP Server listening at port 3000`, it will take few minutes based on your internet connection.\n6. Open http://127.0.0.1:3000\n\n\n## Update\n\nStart your docker and enter the terminal, follow below commands:\n\n```bash\ncd docker-hackmd ## enter the directory\ngit pull ## pull new commits\ndocker-compose pull ## pull new containers\ndocker-compose up ## turn on\n```\n\n### [migration-to-0.5.0](https://github.com/hackmdio/migration-to-0.5.0)\n\n\nWe don't use LZString to compress socket.io data and DB data after version 0.5.0.\nPlease run the migration tool if you're upgrading from the old version.\n\n1. Stop your hackmd containers\n2. Modify `docker-compose.yml`, add expose ports `5432` to `hackmdPostgres`\n3. `docker-compose up` to start your hackmd containers\n4. Backup DB (see below)\n5. Git clone above `migration-to-0.5.0` and `npm install` (see more on above link)\n6. Modify `config.json` in `migration-to-0.5.0`, change its `username`, `password` and `host` to your docker\n7. Run migration (see more on above link)\n8. Stop your hackmd containers\n9. Modify `docker-compose.yml`, remove expose ports `5432` in `hackmdPostgres`\n10. git pull in `docker-hackmd`, update to version 0.5.0 (see below)\n\n\n\n## Backup\n\nStart your docker and enter the terminal, follow below commands:\n\n```bash\n docker-compose exec database pg_dump hackmd -U hackmd  \u003e backup.sql\n```\n\n\n## Restore\n\nSimilar to backup steps, but last command is\n```bash\ncat backup.sql | docker exec -i $(docker-compose ps -q database) psql -U hackmd\n```\n\n# Kubernetes\n\nTo install use `helm install stable/hackmd`.\n\nFor all further details, please check out the offical HackMD  [K8s helm chart](https://github.com/kubernetes/charts/tree/master/stable/hackmd).\n\n# Custom build\n\nThe default setting would use pre-build docker image, if you want to build your own containers\nuncomment the `build` section in the [`docker-compose.yml`](https://github.com/hackmdio/docker-hackmd/blob/master/docker-compose.yml) and edit the [`config.json`](https://github.com/hackmdio/docker-hackmd/blob/master/config.json).\n\nIf you change the database settings and don't use the `HMD_DB_URL` make sure you edit the [`.sequelizerc`](https://github.com/hackmdio/docker-hackmd/blob/master/.sequelizerc).\n\n\n# License\n\nView [license information](https://github.com/hackmdio/hackmd) for the software contained in this image.\n\n\n# Supported Docker versions\n\nThis image is officially supported on Docker version 17.03.1-CE.\n\nSupport for older versions (down to 1.12) is provided on a best-effort basis.\n\nPlease see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.\n\n\n# User Feedback\n\n## Issues\n\nIf you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/hackmdio/docker-hackmd/issues).\n\nYou can also reach many of the project maintainers via the `hackmd` channel on [Gitter](https://gitter.im/hackmdio/hackmd).\n\n\n## Contributing\n\nYou 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.\n\n\n**Happy HackMD :smile:**\n","funding_links":[],"categories":["Shell","docker"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackmdio%2Fdocker-hackmd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhackmdio%2Fdocker-hackmd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackmdio%2Fdocker-hackmd/lists"}