hedgedoc/docs/content/getting-started/user.md
2025-04-15 23:22:00 +02:00

2.1 KiB

Create an user account

This tutorial assumes that you just deployed a HedgeDoc instance with this guide. We'll assume the domain you use for the instance is https://hedgedoc.localhost, so please substitute it with your actual domain anywhere you encounter https://hedgedoc.localhost if that differs.

  1. Go to https://hedgedoc.localhost. You will be greeted by the login page.

    HedgeDoc login page{ width="700" }

  2. Click on the "Register" button in "Sign in via Username" section.

  3. Choose your preferred username, display name and password.

    You are able to change any of these values except the username, so choose a username you want to keep. The username needs to be lowercase and may only contain the letters a-z, the numbers 0-9, and the underscore (_), dot (.) and hyphen (-). Register form{ width="400" }

  4. Click on the "Register" button.

If everything worked, you'll now get redirected to the "explore page", which is the start page for accessing your notes. A notification in the top right confirms your account creation.

Notification confirming the successful account creation{ width="400" }

HedgeDoc stores your login for 14 days in your browser per default. You can configure this session duration via the config options. Of course, you can always log out of your account to clear the session.

The next time you need to log in, just use your chosen username and password.

Further reading