mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2025-02-06 04:52:35 +00:00
21 lines
1 KiB
Markdown
21 lines
1 KiB
Markdown
# 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](https://docs.hedgedoc.org/guides/reverse-proxy/)
|
|
3. [Configure HedgeDoc](https://docs.hedgedoc.org/configuration/)
|
|
|
|
Follow us on <a href="https://social.hedgedoc.org/" target="_blank" rel="noreferer noopener">:fontawesome-brands-mastodon:{: .mastodon }Mastodon</a> or <a href="https://social.hedgedoc.org/twitter" target="_blank" rel="noreferer noopener">:fontawesome-brands-twitter:{: .twitter }Twitter</a> 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/).
|