diff options
| author | David Mehren | 2021-04-13 21:43:48 +0200 |
|---|---|---|
| committer | David Mehren | 2021-04-16 21:19:13 +0200 |
| commit | a3ee2c6f8c5ae29b9dd58d5982127ed026956ed4 (patch) | |
| tree | b0cfe588ff3c65db3c43e704df32d310a28e1862 /docs/content/setup/getting-started.md | |
| parent | 2667b642f4b5aeef9ec0166d0c5986e0605d60e2 (diff) | |
Docs: Move migration hints to getting started page
These are relevant for all installation methods, so they should be
placed at a 'global' place.
Signed-off-by: David Mehren <git@herrmehren.de>
Diffstat (limited to '')
| -rw-r--r-- | docs/content/setup/getting-started.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/content/setup/getting-started.md b/docs/content/setup/getting-started.md index 3592b6bb..4cbb0162 100644 --- a/docs/content/setup/getting-started.md +++ b/docs/content/setup/getting-started.md @@ -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/). |