summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDavid Mehren2021-04-13 21:43:48 +0200
committerDavid Mehren2021-04-16 21:19:13 +0200
commita3ee2c6f8c5ae29b9dd58d5982127ed026956ed4 (patch)
treeb0cfe588ff3c65db3c43e704df32d310a28e1862 /docs
parent2667b642f4b5aeef9ec0166d0c5986e0605d60e2 (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 'docs')
-rw-r--r--docs/content/setup/docker.md20
-rw-r--r--docs/content/setup/getting-started.md10
2 files changed, 13 insertions, 17 deletions
diff --git a/docs/content/setup/docker.md b/docs/content/setup/docker.md
index 1b162399..7803b55d 100644
--- a/docs/content/setup/docker.md
+++ b/docs/content/setup/docker.md
@@ -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
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/).