github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-25 11:16:31 -05:00
Code Issues Projects Releases Packages Wiki Activity

Docs: Move migration hints to getting started page

Browse source 
These are relevant for all installation methods, so they should be
placed at a 'global' place.

Signed-off-by: David Mehren <git@herrmehren.de>
This commit is contained in:
David Mehren 2021-04-13 21:43:48 +02:00
parent 2667b642f4
commit a3ee2c6f8c
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3
2 changed files with 13 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/content/setup/docker.md
View file

@ -68,24 +68,10 @@ Check out [the configuration docs](/configuration) for more details.
You can upgrade to the latest release by stopping the containers and changing the referenced image version in `docker-compose.yml`.
Then run `docker-compose up` to start HedgeDoc again.
### Migrating from HackMD
### Migrating from CodiMD & HackMD
If you used the [`docker-hackmd`](https://github.com/hackmdio/docker-hackmd) repository before,
you can migrate to [`hedgedoc-container`](https://github.com/hedgedoc/container).
`hedgedoc-container` is a fork of `docker-hackmd`, so you need to replace the upstream URL:
```shell
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](https://hedgedoc.org/releases/) 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](https://docs.hedgedoc.org/guides/reverse-proxy/).
If you currently use CodiMD or HackMD, you should be able to swap the docker image for ours.
See [the general migration hints](/setup/getting-started/#migrating-from-codimd-hackmd) for compatibility details.
## Backup

10
docs/content/setup/getting-started.md
View file

@ -19,3 +19,13 @@ You can find more details about upgrading in the instructions of your installati
!!! warning
Before you upgrade, **always read the release notes**.
You can find them on our [releases page](https://hedgedoc.org/releases/).
## Migrating from CodiMD & HackMD
Migrating from CodiMD <= 1.6.0 or HackMD <= 1.1.0 to HedgeDoc should be safe,
just make sure to read the release notes.
A particular issue that has come up is when handling TLS connections using a reverse proxy.
You must [set the `X-Forwarded-Proto` header correctly](https://docs.hedgedoc.org/guides/reverse-proxy/#reverse-proxy-config).
Migrating from more recent versions of CodiMD is not guaranteed to work, although some community members
[reported success migrating from CodiMD 2.2](https://community.hedgedoc.org/t/solved-upgrade-from-dockerlized-codimd/271).
If you successfully migrated from other versions, please report your upgrade results in the [community forum](https://community.hedgedoc.org/).