github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-22 09:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity
hedgedoc/docs/content/setup/getting-started.md
David Mehren c7104c94e4
Docs: Add hint about account creation 
Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-16 21:19:13 +02:00

1.9 KiB
Raw Blame History

Getting started

Thank you for choosing HedgeDoc! To set up your instance follow these steps:

  1. Choose an installation method and follow the instructions
  2. Configure your reverse proxy
  3. Configure HedgeDoc
  4. If you didn't disable local accounts, 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.

Upgrading HedgeDoc

HedgeDoc follows Semantic Versioning.
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.

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.

Migrating from more recent versions of CodiMD is not guaranteed to work, although some community members reported success migrating from CodiMD 2.2. If you successfully migrated from other versions, please report your upgrade results in the community forum.