From 24dbc23ab08eec85d281505439c1a40903f8e6c0 Mon Sep 17 00:00:00 2001 From: David Mehren Date: Wed, 3 Mar 2021 13:51:39 +0100 Subject: Docs: Add a note about upgrading to the getting started guide Signed-off-by: David Mehren --- docs/content/setup/getting-started.md | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'docs/content/setup/getting-started.md') diff --git a/docs/content/setup/getting-started.md b/docs/content/setup/getting-started.md index a8180793..3592b6bb 100644 --- a/docs/content/setup/getting-started.md +++ b/docs/content/setup/getting-started.md @@ -8,3 +8,14 @@ To set up your instance follow these steps: 3. [Configure HedgeDoc](https://docs.hedgedoc.org/configuration/) Follow us on :fontawesome-brands-mastodon:{: .mastodon }Mastodon or :fontawesome-brands-twitter:{: .twitter }Twitter for updates. + +## Upgrading HedgeDoc + +HedgeDoc follows [Semantic Versioning](https://semver.org/). +This means that minor and patch releases should not introduce user-facing backwards-incompatible changes. + +You can find more details about upgrading in the instructions of your installation method. + +!!! warning + Before you upgrade, **always read the release notes**. + You can find them on our [releases page](https://hedgedoc.org/releases/). -- cgit v1.2.3 From a3ee2c6f8c5ae29b9dd58d5982127ed026956ed4 Mon Sep 17 00:00:00 2001 From: David Mehren Date: Tue, 13 Apr 2021 21:43:48 +0200 Subject: 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 --- docs/content/setup/getting-started.md | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'docs/content/setup/getting-started.md') 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/). -- cgit v1.2.3 From c7104c94e4274f5010adb2fd6088ff1f4367dbfb Mon Sep 17 00:00:00 2001 From: David Mehren Date: Tue, 13 Apr 2021 22:22:03 +0200 Subject: Docs: Add hint about account creation Signed-off-by: David Mehren --- docs/content/setup/getting-started.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/content/setup/getting-started.md') diff --git a/docs/content/setup/getting-started.md b/docs/content/setup/getting-started.md index 4cbb0162..2b1f8653 100644 --- a/docs/content/setup/getting-started.md +++ b/docs/content/setup/getting-started.md @@ -6,6 +6,8 @@ To set up your instance follow these steps: 1. Choose an installation method and follow the instructions 2. [Configure your reverse proxy](https://docs.hedgedoc.org/guides/reverse-proxy/) 3. [Configure HedgeDoc](https://docs.hedgedoc.org/configuration/) +4. If you didn't disable [local accounts](/configuration/#email-local-account), you can use the "Sign In" button to + create an account, login and start using HedgeDoc. Follow us on :fontawesome-brands-mastodon:{: .mastodon }Mastodon or :fontawesome-brands-twitter:{: .twitter }Twitter for updates. -- cgit v1.2.3