summaryrefslogtreecommitdiff
path: root/docs/content/setup/getting-started.md
blob: 3592b6bbfe78582bb410d2e69e4ade473c3eb44c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# 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/).