summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/content/guides/migrations-and-breaking-changes.md55
-rw-r--r--docs/content/images/hedgedoc_logo_black.svg1
-rw-r--r--docs/content/images/hedgedoc_logo_horizontal.svg1
-rw-r--r--docs/content/images/hedgedoc_logo_white.svg1
-rw-r--r--docs/content/images/logo.svg2
-rw-r--r--docs/content/index.md3
-rw-r--r--docs/content/setup/docker.md95
-rw-r--r--docs/content/setup/getting-started.md25
-rw-r--r--docs/content/setup/manual-setup.md174
-rw-r--r--docs/content/theme/styles/hedgedoc-custom.css50
-rw-r--r--docs/mkdocs.yml20
-rw-r--r--docs/requirements.txt2
12 files changed, 312 insertions, 117 deletions
diff --git a/docs/content/guides/migrations-and-breaking-changes.md b/docs/content/guides/migrations-and-breaking-changes.md
deleted file mode 100644
index bbc320b1..00000000
--- a/docs/content/guides/migrations-and-breaking-changes.md
+++ /dev/null
@@ -1,55 +0,0 @@
-# Migrations and Notable Changes
-
-## Migrating to 1.4.0
-
-We dropped support for node 6 with this version. If you have any trouble running this version, please double check that you are running at least node 8!
-
-## Migrating to 1.3.2
-
-This is not a breaking change, but to stay up to date with the community
-repository, you may need to update a few urls. This is not a breaking change.
-
-See more at [issue #10](https://github.com/hedgedoc/hedgedoc/issues/10)
-
-### Native setup using git
-
-Change the upstream remote using `git remote set-url origin https://github.com/hedgedoc/hedgedoc.git`.
-
-### Docker
-
-When you use our [container repository](https://github.com/hedgedoc/container)
-(which was previously `hedgedoc-container`) all you can simply run `git pull` and
-your `docker-compose.yml` will be updated.
-
-When you setup things yourself, make sure you use the new image:
-[`quay.io/hedgedoc/hedgedoc`](https://quay.io/repository/hedgedoc/hedgedoc?tab=tags).
-
-### Heroku
-
-All you need to do is [disconnect GitHub](https://devcenter.heroku.com/articles/github-integration#disconnecting-from-github)
-and [reconnect it](https://devcenter.heroku.com/articles/github-integration#enabling-github-integration)
-with this new repository.
-
-Or you can use our Heroku button and redeploy your instance and link the old
-database again.
-
-## Migrating to 1.1.0
-
-We deprecated the older lower case config style and moved on to camel case style. Please have a look at the current `config.json.example` and check the warnings on startup.
-
-*Notice: This is not a breaking change right now but will be in the future*
-
-## Migrating to 0.5.0
-
-[migration-to-0.5.0 migration tool](https://github.com/hackmdio/migration-to-0.5.0)
-
-We don't use LZString to compress socket.io data and DB data after version 0.5.0.
-Please run the migration tool if you're upgrading from the old version.
-
-## Migrating to 0.4.0
-
-[migration-to-0.4.0 migration tool](https://github.com/hackmdio/migration-to-0.4.0)
-
-We've dropped MongoDB after version 0.4.0.
-So here is the migration tool for you to transfer the old DB data to the new DB.
-This tool is also used for official service.
diff --git a/docs/content/images/hedgedoc_logo_black.svg b/docs/content/images/hedgedoc_logo_black.svg
new file mode 100644
index 00000000..b8bcd7ae
--- /dev/null
+++ b/docs/content/images/hedgedoc_logo_black.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="786" height="197.266" clip-rule="evenodd" fill-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2"><path d="M248.07 58v79.68h9.297v-35.058h45.416v35.058h9.296V58h-9.296v36.123h-45.416V58zm187.351 0v33.518c-2.372-2.513-5.223-4.478-8.552-5.895-3.33-1.417-6.941-2.125-10.836-2.125-5.134 0-9.73 1.193-13.785 3.584-4.054 2.392-7.243 5.667-9.56 9.828-2.321 4.163-3.48 8.897-3.48 14.208 0 5.314 1.159 10.051 3.48 14.21 2.317 4.161 5.506 7.437 9.56 9.828 4.055 2.391 8.65 3.587 13.785 3.587 4.001 0 7.702-.753 11.102-2.258 3.4-1.506 6.285-3.568 8.659-6.19l.479 7.385h7.913V58zm157.87.106v79.68h21.673c15.653 0 27.676-3.488 36.068-10.466 8.392-6.974 12.59-16.803 12.59-29.48 0-12.642-4.198-22.425-12.59-29.348-8.392-6.923-20.415-10.386-36.068-10.386zm9.296 8.5h12.377c12.606 0 22.275 2.719 29.004 8.153 6.728 5.438 10.091 13.13 10.091 23.082 0 9.985-3.363 17.724-10.09 23.212-6.73 5.49-16.399 8.234-29.005 8.234h-12.377zm-118.295 16.89c-5.134 0-9.73 1.196-13.784 3.587-4.055 2.391-7.244 5.666-9.562 9.827-2.32 4.161-3.48 8.897-3.48 14.21 0 5.312 1.16 10.048 3.48 14.21 2.318 4.16 5.507 7.435 9.562 9.826 4.054 2.391 8.65 3.586 13.784 3.586 3.895 0 7.507-.709 10.837-2.125 3.328-1.416 6.179-3.38 8.551-5.895v2.76c0 7.225-1.815 13.005-5.444 17.345-3.632 4.336-9.216 6.505-16.759 6.505-2.975 0-5.737-.487-8.286-1.46-2.55-.975-4.818-2.329-6.8-4.063l-4.355 7.33c2.619 1.948 5.558 3.46 8.816 4.541 3.258 1.082 6.745 1.62 10.465 1.62 6.763 0 12.457-1.373 17.08-4.116 4.62-2.745 8.116-6.578 10.49-11.5 2.372-4.923 3.558-10.66 3.558-17.211V84.559h-7.915l-.479 7.385c-2.372-2.621-5.258-4.684-8.658-6.19-3.399-1.505-7.1-2.257-11.1-2.257zm281.895 0c-5.312 0-10.049 1.196-14.21 3.587-4.16 2.39-7.436 5.666-9.828 9.828-2.389 4.161-3.584 8.896-3.584 14.208 0 5.313 1.195 10.05 3.584 14.21 2.392 4.162 5.667 7.437 9.828 9.826 4.161 2.391 8.898 3.587 14.21 3.587 4.001 0 7.683-.69 11.048-2.072 3.364-1.382 6.286-3.311 8.765-5.79l-6.11-6.056c-1.665 1.842-3.665 3.293-6.001 4.355-2.338 1.063-4.905 1.595-7.702 1.595-3.577 0-6.765-.85-9.562-2.551-2.798-1.7-5.003-4.037-6.614-7.01-1.611-2.975-2.416-6.34-2.416-10.094 0-3.788.805-7.162 2.416-10.12 1.61-2.956 3.816-5.284 6.614-6.983 2.797-1.701 5.985-2.55 9.562-2.55 2.797 0 5.364.522 7.702 1.565a17.433 17.433 0 0 1 6.001 4.384l6.11-6.11c-2.479-2.442-5.4-4.355-8.765-5.736-3.365-1.382-7.047-2.072-11.048-2.072zm-413.42.002c-5.24 0-9.932 1.188-14.076 3.56-4.144 2.373-7.402 5.623-9.774 9.748-2.372 4.125-3.56 8.808-3.56 14.05 0 5.384 1.267 10.18 3.8 14.395 2.53 4.214 6.027 7.516 10.49 9.907 4.462 2.39 15.298 3.585 15.298 3.585 3.577 0 7.286-.602 11.13-1.807 3.841-1.204 7.692-3.416 11.552-6.64l-5.152-6.586c-2.622 2.479-5.525 4.276-8.71 5.392-3.19 1.114-6.216 1.673-9.086 1.673-5.17 0-9.588-1.514-13.253-4.54-3.665-3.03-5.94-6.9-6.825-11.61h45.045v-3.557c0-5.347-1.152-10.094-3.454-14.236-2.302-4.144-5.47-7.401-9.507-9.775-4.038-2.37-8.676-3.559-13.918-3.559zm200.366 0c-5.241 0-9.933 1.188-14.076 3.56-4.144 2.373-7.402 5.623-9.774 9.748-2.373 4.125-3.56 8.808-3.56 14.05 0 5.384 1.265 10.18 3.799 14.395 2.53 4.214 6.029 7.516 10.49 9.907 4.462 2.39 9.562 3.585 15.299 3.585 3.577 0 7.285-.602 11.128-1.807 3.842-1.204 7.693-3.416 11.554-6.64l-5.154-6.586c-2.62 2.479-5.523 4.276-8.71 5.392-3.187 1.114-6.215 1.673-9.084 1.673-5.17 0-9.588-1.514-13.253-4.54-3.665-3.03-5.94-6.9-6.826-11.61h45.045v-3.557c0-5.347-1.151-10.094-3.453-14.236-2.302-4.144-5.471-7.401-9.508-9.775-4.038-2.37-8.675-3.559-13.917-3.559zm148.248 0c-5.312 0-10.047 1.194-14.208 3.585-4.162 2.391-7.438 5.667-9.829 9.828-2.389 4.16-3.584 8.897-3.584 14.208 0 5.313 1.195 10.05 3.584 14.21 2.392 4.162 5.667 7.437 9.83 9.828 4.16 2.39 8.895 3.585 14.207 3.585 5.311 0 10.048-1.194 14.21-3.585 4.16-2.391 7.435-5.666 9.826-9.827 2.391-4.161 3.586-8.898 3.586-14.211 0-5.311-1.195-10.047-3.586-14.208-2.39-4.161-5.666-7.437-9.827-9.828-4.16-2.391-8.898-3.585-14.209-3.585zM485.09 91.464c3.576 0 6.764.85 9.56 2.552 2.799 1.699 5.004 4.029 6.614 6.983 1.612 2.958 2.417 6.332 2.417 10.12 0 3.754-.805 7.118-2.417 10.093-1.61 2.975-3.815 5.311-6.613 7.012-2.797 1.7-5.985 2.549-9.561 2.549-3.577 0-6.765-.85-9.562-2.549-2.798-1.7-5.002-4.037-6.612-7.012-1.613-2.975-2.418-6.339-2.418-10.093 0-3.788.805-7.162 2.418-10.12 1.61-2.954 3.814-5.284 6.612-6.983 2.797-1.701 5.985-2.552 9.562-2.552zm-68.26.001c3.578 0 6.766.85 9.562 2.55 2.798 1.7 5.002 4.029 6.614 6.985 1.61 2.957 2.416 6.331 2.416 10.118 0 3.754-.806 7.118-2.416 10.093-1.612 2.975-3.816 5.313-6.614 7.012-2.796 1.701-5.984 2.55-9.562 2.55-3.577 0-6.764-.849-9.56-2.55-2.798-1.7-5.003-4.037-6.614-7.012-1.611-2.975-2.417-6.339-2.417-10.093 0-3.787.806-7.16 2.417-10.118 1.61-2.956 3.816-5.285 6.614-6.986 2.796-1.699 5.983-2.549 9.56-2.549zm-64.114 0c4.638 0 8.57 1.46 11.792 4.384 3.222 2.922 5.222 6.7 6.002 11.34h-36.015c.78-4.567 2.834-8.33 6.163-11.288 3.328-2.956 7.348-4.435 12.058-4.435zm200.366 0c4.638 0 8.568 1.46 11.79 4.384 3.222 2.922 5.224 6.7 6.003 11.34H534.86c.779-4.567 2.833-8.33 6.162-11.288 3.328-2.956 7.348-4.435 12.059-4.435zm148.3 0c3.576 0 6.766.85 9.562 2.55 2.798 1.701 5.002 4.03 6.614 6.986 1.61 2.956 2.416 6.33 2.416 10.118 0 3.754-.806 7.119-2.416 10.094-1.612 2.974-3.816 5.31-6.614 7.011-2.796 1.7-5.986 2.55-9.562 2.55-3.577 0-6.764-.85-9.56-2.55-2.798-1.7-5.004-4.037-6.614-7.011-1.613-2.975-2.417-6.34-2.417-10.094 0-3.789.804-7.162 2.417-10.118 1.61-2.956 3.816-5.285 6.613-6.986 2.797-1.7 5.984-2.55 9.561-2.55z" fill-rule="nonzero"/><path d="m187.345 108.66 9.992-9.992-9.992-9.992 7.517-11.963-11.964-7.518 4.667-13.337-13.336-4.667 1.581-14.04-14.04-1.583-1.583-14.042-14.04 1.582-4.668-13.337-13.336 4.666-7.52-11.963L108.66 9.99 98.67 0l-9.992 9.992-11.964-7.517-7.517 11.963L55.86 9.771l-4.667 13.337-14.041-1.583-1.582 14.041-14.04 1.582 1.581 14.04-13.338 4.668 4.667 13.337L2.475 76.71l7.518 11.966L0 98.668l9.992 9.993-7.517 11.964 11.964 7.517-4.667 13.337 13.338 4.668-1.582 14.039 14.04 1.583 1.583 14.04 14.041-1.581 4.667 13.335 13.336-4.665 7.518 11.964 11.963-7.518 9.992 9.899 9.992-9.896 11.964 7.517 7.517-11.966 13.338 4.668 4.666-13.337 14.042 1.581 1.581-14.041 14.042-1.582-1.583-14.04 13.338-4.668-4.667-13.338 11.964-7.517z" fill="#b51f08" fill-rule="nonzero"/><path d="M167.114 114.463c0-19.312-15.655-34.967-34.967-34.967-9.592 0-18.282 3.865-24.599 10.121l-.004-.004-8.909 8.91-7.285-7.285c-6.409-7.312-15.81-11.934-26.296-11.934-19.313 0-34.968 15.655-34.968 34.967 0 10.092 4.28 19.178 11.117 25.56l57.466 57.435 56.196-56.233c7.022-6.608 12.25-15.934 12.25-26.57" fill="#fdd49a" fill-rule="nonzero"/><path d="m98.635 98.522-7.285-7.284c-6.41-7.312-15.81-11.935-26.297-11.935-19.312 0-34.967 15.656-34.967 34.967 0 10.092 4.28 19.178 11.117 25.56l57.466 57.436" fill="url(#a)" fill-rule="nonzero"/><path d="m98.669 197.266-.034-98.744" fill="none"/><path d="M108.65 187.336a14.075 14.075 0 0 0-10.001-4.157 14.075 14.075 0 0 0-10.002 4.157c.04 5.49 4.502 9.927 10.001 9.927 5.5 0 9.962-4.439 10.003-9.927M86.967 126.87a7.643 7.643 0 1 1-15.287 0 7.643 7.643 0 1 1 15.287 0" fill="#010007" fill-rule="nonzero"/><path d="M84.345 125.724a2.116 2.116 0 0 1-2.118 2.117 2.117 2.117 0 1 1 0-4.236 2.12 2.12 0 0 1 2.118 2.12" fill="#fffffa" fill-rule="nonzero"/><path d="M125.732 126.87a7.644 7.644 0 1 1-15.288 0 7.644 7.644 0 1 1 15.288 0" fill="#010007" fill-rule="nonzero"/><path d="M123.11 125.724c0 1.172-.95 2.117-2.118 2.117a2.117 2.117 0 1 1 0-4.236 2.12 2.12 0 0 1 2.118 2.12" fill="#fffffa" fill-rule="nonzero"/><defs><linearGradient id="a" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="rotate(-64.537 160.23 25.078) scale(61.7694)"><stop offset="0" stop-color="#fdd49a"/><stop offset="1" stop-color="#dca055"/></linearGradient></defs></svg> \ No newline at end of file
diff --git a/docs/content/images/hedgedoc_logo_horizontal.svg b/docs/content/images/hedgedoc_logo_horizontal.svg
deleted file mode 100644
index 387e2c03..00000000
--- a/docs/content/images/hedgedoc_logo_horizontal.svg
+++ /dev/null
@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="786" height="197.266" clip-rule="evenodd" fill-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2"><path d="M248.07 58v79.68h9.297v-35.058h45.416v35.058h9.296V58h-9.296v36.123h-45.416V58zm187.351 0v33.518c-2.372-2.513-5.223-4.478-8.552-5.895-3.33-1.417-6.941-2.125-10.836-2.125-5.134 0-9.73 1.193-13.785 3.584-4.054 2.392-7.243 5.667-9.56 9.828-2.321 4.163-3.48 8.897-3.48 14.208 0 5.314 1.159 10.051 3.48 14.21 2.317 4.161 5.506 7.437 9.56 9.828 4.055 2.391 8.65 3.587 13.785 3.587 4.001 0 7.702-.753 11.102-2.258 3.4-1.506 6.285-3.568 8.659-6.19l.479 7.385h7.913V58zm157.87.106v79.68h21.673c15.653 0 27.676-3.488 36.068-10.466 8.392-6.974 12.59-16.803 12.59-29.48 0-12.642-4.198-22.425-12.59-29.348-8.392-6.923-20.415-10.386-36.068-10.386zm9.296 8.5h12.377c12.606 0 22.275 2.719 29.004 8.153 6.728 5.438 10.091 13.13 10.091 23.082 0 9.985-3.363 17.724-10.09 23.212-6.73 5.49-16.399 8.234-29.005 8.234h-12.377zm-118.295 16.89c-5.134 0-9.73 1.196-13.784 3.587-4.055 2.391-7.244 5.666-9.562 9.827-2.32 4.161-3.48 8.897-3.48 14.21 0 5.312 1.16 10.048 3.48 14.21 2.318 4.16 5.507 7.435 9.562 9.826 4.054 2.391 8.65 3.586 13.784 3.586 3.895 0 7.507-.709 10.837-2.125 3.328-1.416 6.179-3.38 8.551-5.895v2.76c0 7.225-1.815 13.005-5.444 17.345-3.632 4.336-9.216 6.505-16.759 6.505-2.975 0-5.737-.487-8.286-1.46-2.55-.975-4.818-2.329-6.8-4.063l-4.355 7.33c2.619 1.948 5.558 3.46 8.816 4.541 3.258 1.082 6.745 1.62 10.465 1.62 6.763 0 12.457-1.373 17.08-4.116 4.62-2.745 8.116-6.578 10.49-11.5 2.372-4.923 3.558-10.66 3.558-17.211V84.559h-7.915l-.479 7.385c-2.372-2.621-5.258-4.684-8.658-6.19-3.399-1.505-7.1-2.257-11.1-2.257zm281.895 0c-5.312 0-10.049 1.196-14.21 3.587-4.16 2.39-7.436 5.666-9.828 9.828-2.389 4.161-3.584 8.896-3.584 14.208 0 5.313 1.195 10.05 3.584 14.21 2.392 4.162 5.667 7.437 9.828 9.826 4.161 2.391 8.898 3.587 14.21 3.587 4.001 0 7.683-.69 11.048-2.072 3.364-1.382 6.286-3.311 8.765-5.79l-6.11-6.056c-1.665 1.842-3.665 3.293-6.001 4.355-2.338 1.063-4.905 1.595-7.702 1.595-3.577 0-6.765-.85-9.562-2.551-2.798-1.7-5.003-4.037-6.614-7.01-1.611-2.975-2.416-6.34-2.416-10.094 0-3.788.805-7.162 2.416-10.12 1.61-2.956 3.816-5.284 6.614-6.983 2.797-1.701 5.985-2.55 9.562-2.55 2.797 0 5.364.522 7.702 1.565a17.433 17.433 0 016.001 4.384l6.11-6.11c-2.479-2.442-5.4-4.355-8.765-5.736-3.365-1.382-7.047-2.072-11.048-2.072zm-413.42.002c-5.24 0-9.932 1.188-14.076 3.56-4.144 2.373-7.402 5.623-9.774 9.748-2.372 4.125-3.56 8.808-3.56 14.05 0 5.384 1.267 10.18 3.8 14.395 2.53 4.214 6.027 7.516 10.49 9.907 4.462 2.39 15.298 3.585 15.298 3.585 3.577 0 7.286-.602 11.13-1.807 3.841-1.204 7.692-3.416 11.552-6.64l-5.152-6.586c-2.622 2.479-5.525 4.276-8.71 5.392-3.19 1.114-6.216 1.673-9.086 1.673-5.17 0-9.588-1.514-13.253-4.54-3.665-3.03-5.94-6.9-6.825-11.61h45.045v-3.557c0-5.347-1.152-10.094-3.454-14.236-2.302-4.144-5.47-7.401-9.507-9.775-4.038-2.37-8.676-3.559-13.918-3.559zm200.366 0c-5.241 0-9.933 1.188-14.076 3.56-4.144 2.373-7.402 5.623-9.774 9.748-2.373 4.125-3.56 8.808-3.56 14.05 0 5.384 1.265 10.18 3.799 14.395 2.53 4.214 6.029 7.516 10.49 9.907 4.462 2.39 9.562 3.585 15.299 3.585 3.577 0 7.285-.602 11.128-1.807 3.842-1.204 7.693-3.416 11.554-6.64l-5.154-6.586c-2.62 2.479-5.523 4.276-8.71 5.392-3.187 1.114-6.215 1.673-9.084 1.673-5.17 0-9.588-1.514-13.253-4.54-3.665-3.03-5.94-6.9-6.826-11.61h45.045v-3.557c0-5.347-1.151-10.094-3.453-14.236-2.302-4.144-5.471-7.401-9.508-9.775-4.038-2.37-8.675-3.559-13.917-3.559zm148.248 0c-5.312 0-10.047 1.194-14.208 3.585-4.162 2.391-7.438 5.667-9.829 9.828-2.389 4.16-3.584 8.897-3.584 14.208 0 5.313 1.195 10.05 3.584 14.21 2.392 4.162 5.667 7.437 9.83 9.828 4.16 2.39 8.895 3.585 14.207 3.585 5.311 0 10.048-1.194 14.21-3.585 4.16-2.391 7.435-5.666 9.826-9.827 2.391-4.161 3.586-8.898 3.586-14.211 0-5.311-1.195-10.047-3.586-14.208-2.39-4.161-5.666-7.437-9.827-9.828-4.16-2.391-8.898-3.585-14.209-3.585zM485.09 91.464c3.576 0 6.764.85 9.56 2.552 2.799 1.699 5.004 4.029 6.614 6.983 1.612 2.958 2.417 6.332 2.417 10.12 0 3.754-.805 7.118-2.417 10.093-1.61 2.975-3.815 5.311-6.613 7.012-2.797 1.7-5.985 2.549-9.561 2.549-3.577 0-6.765-.85-9.562-2.549-2.798-1.7-5.002-4.037-6.612-7.012-1.613-2.975-2.418-6.339-2.418-10.093 0-3.788.805-7.162 2.418-10.12 1.61-2.954 3.814-5.284 6.612-6.983 2.797-1.701 5.985-2.552 9.562-2.552zm-68.26.001c3.578 0 6.766.85 9.562 2.55 2.798 1.7 5.002 4.029 6.614 6.985 1.61 2.957 2.416 6.331 2.416 10.118 0 3.754-.806 7.118-2.416 10.093-1.612 2.975-3.816 5.313-6.614 7.012-2.796 1.701-5.984 2.55-9.562 2.55-3.577 0-6.764-.849-9.56-2.55-2.798-1.7-5.003-4.037-6.614-7.012-1.611-2.975-2.417-6.339-2.417-10.093 0-3.787.806-7.16 2.417-10.118 1.61-2.956 3.816-5.285 6.614-6.986 2.796-1.699 5.983-2.549 9.56-2.549zm-64.114 0c4.638 0 8.57 1.46 11.792 4.384 3.222 2.922 5.222 6.7 6.002 11.34h-36.015c.78-4.567 2.834-8.33 6.163-11.288 3.328-2.956 7.348-4.435 12.058-4.435zm200.366 0c4.638 0 8.568 1.46 11.79 4.384 3.222 2.922 5.224 6.7 6.003 11.34H534.86c.779-4.567 2.833-8.33 6.162-11.288 3.328-2.956 7.348-4.435 12.059-4.435zm148.3 0c3.576 0 6.766.85 9.562 2.55 2.798 1.701 5.002 4.03 6.614 6.986 1.61 2.956 2.416 6.33 2.416 10.118 0 3.754-.806 7.119-2.416 10.094-1.612 2.974-3.816 5.31-6.614 7.011-2.796 1.7-5.986 2.55-9.562 2.55-3.577 0-6.764-.85-9.56-2.55-2.798-1.7-5.004-4.037-6.614-7.011-1.613-2.975-2.417-6.34-2.417-10.094 0-3.789.804-7.162 2.417-10.118 1.61-2.956 3.816-5.285 6.613-6.986 2.797-1.7 5.984-2.55 9.561-2.55z" fill-rule="nonzero"/><path d="M187.345 108.66l9.992-9.992-9.992-9.992 7.517-11.963-11.964-7.518 4.667-13.337-13.336-4.667 1.581-14.04-14.04-1.583-1.583-14.042-14.04 1.582-4.668-13.337-13.336 4.666-7.52-11.963L108.66 9.99 98.67 0l-9.992 9.992-11.964-7.517-7.517 11.963L55.86 9.771l-4.667 13.337-14.041-1.583-1.582 14.041-14.04 1.582 1.581 14.04-13.338 4.668 4.667 13.337L2.475 76.71l7.518 11.966L0 98.668l9.992 9.993-7.517 11.964 11.964 7.517-4.667 13.337 13.338 4.668-1.582 14.039 14.04 1.583 1.583 14.04 14.041-1.581 4.667 13.335 13.336-4.665 7.518 11.964 11.963-7.518 9.992 9.899 9.992-9.896 11.964 7.517 7.517-11.966 13.338 4.668 4.666-13.337 14.042 1.581 1.581-14.041 14.042-1.582-1.583-14.04 13.338-4.668-4.667-13.338 11.964-7.517z" fill="#b51f08" fill-rule="nonzero"/><path d="M167.114 114.463c0-19.312-15.655-34.967-34.967-34.967-9.592 0-18.282 3.865-24.599 10.121l-.004-.004-8.909 8.91-7.285-7.285c-6.409-7.312-15.81-11.934-26.296-11.934-19.313 0-34.968 15.655-34.968 34.967 0 10.092 4.28 19.178 11.117 25.56l57.466 57.435 56.196-56.233c7.022-6.608 12.25-15.934 12.25-26.57" fill="#fdd49a" fill-rule="nonzero"/><path d="M98.635 98.522l-7.285-7.284c-6.41-7.312-15.81-11.935-26.297-11.935-19.312 0-34.967 15.656-34.967 34.967 0 10.092 4.28 19.178 11.117 25.56l57.466 57.436" fill="url(#_Linear1)" fill-rule="nonzero"/><path d="M98.669 197.266l-.034-98.744" fill="none"/><path d="M108.65 187.336a14.075 14.075 0 00-10.001-4.157 14.075 14.075 0 00-10.002 4.157c.04 5.49 4.502 9.927 10.001 9.927 5.5 0 9.962-4.439 10.003-9.927M86.967 126.87a7.643 7.643 0 11-15.287 0 7.643 7.643 0 1115.287 0" fill="#010007" fill-rule="nonzero"/><path d="M84.345 125.724a2.116 2.116 0 01-2.118 2.117 2.117 2.117 0 110-4.236 2.12 2.12 0 012.118 2.12" fill="#fffffa" fill-rule="nonzero"/><path d="M125.732 126.87a7.644 7.644 0 11-15.288 0 7.644 7.644 0 1115.288 0" fill="#010007" fill-rule="nonzero"/><path d="M123.11 125.724c0 1.172-.95 2.117-2.118 2.117a2.117 2.117 0 110-4.236 2.12 2.12 0 012.118 2.12" fill="#fffffa" fill-rule="nonzero"/><defs id="defs77"><linearGradient id="_Linear1" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="rotate(-64.537 160.23 25.078) scale(61.7694)"><stop offset="0" id="stop72" stop-color="#fdd49a" stop-opacity="1"/><stop offset="1" id="stop74" stop-color="#dca055" stop-opacity="1"/></linearGradient></defs></svg> \ No newline at end of file
diff --git a/docs/content/images/hedgedoc_logo_white.svg b/docs/content/images/hedgedoc_logo_white.svg
new file mode 100644
index 00000000..6a6fa39a
--- /dev/null
+++ b/docs/content/images/hedgedoc_logo_white.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="786" height="197.266" clip-rule="evenodd" fill-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2"><path d="M248.07 58v79.68h9.297v-35.058h45.416v35.058h9.296V58h-9.296v36.123h-45.416V58zm187.351 0v33.518c-2.372-2.513-5.223-4.478-8.552-5.895-3.33-1.417-6.941-2.125-10.836-2.125-5.134 0-9.73 1.193-13.785 3.584-4.054 2.392-7.243 5.667-9.56 9.828-2.321 4.163-3.48 8.897-3.48 14.208 0 5.314 1.159 10.051 3.48 14.21 2.317 4.161 5.506 7.437 9.56 9.828 4.055 2.391 8.65 3.587 13.785 3.587 4.001 0 7.702-.753 11.102-2.258 3.4-1.506 6.285-3.568 8.659-6.19l.479 7.385h7.913V58zm157.87.106v79.68h21.673c15.653 0 27.676-3.488 36.068-10.466 8.392-6.974 12.59-16.803 12.59-29.48 0-12.642-4.198-22.425-12.59-29.348-8.392-6.923-20.415-10.386-36.068-10.386zm9.296 8.5h12.377c12.606 0 22.275 2.719 29.004 8.153 6.728 5.438 10.091 13.13 10.091 23.082 0 9.985-3.363 17.724-10.09 23.212-6.73 5.49-16.399 8.234-29.005 8.234h-12.377zm-118.295 16.89c-5.134 0-9.73 1.196-13.784 3.587-4.055 2.391-7.244 5.666-9.562 9.827-2.32 4.161-3.48 8.897-3.48 14.21 0 5.312 1.16 10.048 3.48 14.21 2.318 4.16 5.507 7.435 9.562 9.826 4.054 2.391 8.65 3.586 13.784 3.586 3.895 0 7.507-.709 10.837-2.125 3.328-1.416 6.179-3.38 8.551-5.895v2.76c0 7.225-1.815 13.005-5.444 17.345-3.632 4.336-9.216 6.505-16.759 6.505-2.975 0-5.737-.487-8.286-1.46-2.55-.975-4.818-2.329-6.8-4.063l-4.355 7.33c2.619 1.948 5.558 3.46 8.816 4.541 3.258 1.082 6.745 1.62 10.465 1.62 6.763 0 12.457-1.373 17.08-4.116 4.62-2.745 8.116-6.578 10.49-11.5 2.372-4.923 3.558-10.66 3.558-17.211V84.559h-7.915l-.479 7.385c-2.372-2.621-5.258-4.684-8.658-6.19-3.399-1.505-7.1-2.257-11.1-2.257zm281.895 0c-5.312 0-10.049 1.196-14.21 3.587-4.16 2.39-7.436 5.666-9.828 9.828-2.389 4.161-3.584 8.896-3.584 14.208 0 5.313 1.195 10.05 3.584 14.21 2.392 4.162 5.667 7.437 9.828 9.826 4.161 2.391 8.898 3.587 14.21 3.587 4.001 0 7.683-.69 11.048-2.072 3.364-1.382 6.286-3.311 8.765-5.79l-6.11-6.056c-1.665 1.842-3.665 3.293-6.001 4.355-2.338 1.063-4.905 1.595-7.702 1.595-3.577 0-6.765-.85-9.562-2.551-2.798-1.7-5.003-4.037-6.614-7.01-1.611-2.975-2.416-6.34-2.416-10.094 0-3.788.805-7.162 2.416-10.12 1.61-2.956 3.816-5.284 6.614-6.983 2.797-1.701 5.985-2.55 9.562-2.55 2.797 0 5.364.522 7.702 1.565a17.433 17.433 0 0 1 6.001 4.384l6.11-6.11c-2.479-2.442-5.4-4.355-8.765-5.736-3.365-1.382-7.047-2.072-11.048-2.072zm-413.42.002c-5.24 0-9.932 1.188-14.076 3.56-4.144 2.373-7.402 5.623-9.774 9.748-2.372 4.125-3.56 8.808-3.56 14.05 0 5.384 1.267 10.18 3.8 14.395 2.53 4.214 6.027 7.516 10.49 9.907 4.462 2.39 15.298 3.585 15.298 3.585 3.577 0 7.286-.602 11.13-1.807 3.841-1.204 7.692-3.416 11.552-6.64l-5.152-6.586c-2.622 2.479-5.525 4.276-8.71 5.392-3.19 1.114-6.216 1.673-9.086 1.673-5.17 0-9.588-1.514-13.253-4.54-3.665-3.03-5.94-6.9-6.825-11.61h45.045v-3.557c0-5.347-1.152-10.094-3.454-14.236-2.302-4.144-5.47-7.401-9.507-9.775-4.038-2.37-8.676-3.559-13.918-3.559zm200.366 0c-5.241 0-9.933 1.188-14.076 3.56-4.144 2.373-7.402 5.623-9.774 9.748-2.373 4.125-3.56 8.808-3.56 14.05 0 5.384 1.265 10.18 3.799 14.395 2.53 4.214 6.029 7.516 10.49 9.907 4.462 2.39 9.562 3.585 15.299 3.585 3.577 0 7.285-.602 11.128-1.807 3.842-1.204 7.693-3.416 11.554-6.64l-5.154-6.586c-2.62 2.479-5.523 4.276-8.71 5.392-3.187 1.114-6.215 1.673-9.084 1.673-5.17 0-9.588-1.514-13.253-4.54-3.665-3.03-5.94-6.9-6.826-11.61h45.045v-3.557c0-5.347-1.151-10.094-3.453-14.236-2.302-4.144-5.471-7.401-9.508-9.775-4.038-2.37-8.675-3.559-13.917-3.559zm148.248 0c-5.312 0-10.047 1.194-14.208 3.585-4.162 2.391-7.438 5.667-9.829 9.828-2.389 4.16-3.584 8.897-3.584 14.208 0 5.313 1.195 10.05 3.584 14.21 2.392 4.162 5.667 7.437 9.83 9.828 4.16 2.39 8.895 3.585 14.207 3.585 5.311 0 10.048-1.194 14.21-3.585 4.16-2.391 7.435-5.666 9.826-9.827 2.391-4.161 3.586-8.898 3.586-14.211 0-5.311-1.195-10.047-3.586-14.208-2.39-4.161-5.666-7.437-9.827-9.828-4.16-2.391-8.898-3.585-14.209-3.585zM485.09 91.464c3.576 0 6.764.85 9.56 2.552 2.799 1.699 5.004 4.029 6.614 6.983 1.612 2.958 2.417 6.332 2.417 10.12 0 3.754-.805 7.118-2.417 10.093-1.61 2.975-3.815 5.311-6.613 7.012-2.797 1.7-5.985 2.549-9.561 2.549-3.577 0-6.765-.85-9.562-2.549-2.798-1.7-5.002-4.037-6.612-7.012-1.613-2.975-2.418-6.339-2.418-10.093 0-3.788.805-7.162 2.418-10.12 1.61-2.954 3.814-5.284 6.612-6.983 2.797-1.701 5.985-2.552 9.562-2.552zm-68.26.001c3.578 0 6.766.85 9.562 2.55 2.798 1.7 5.002 4.029 6.614 6.985 1.61 2.957 2.416 6.331 2.416 10.118 0 3.754-.806 7.118-2.416 10.093-1.612 2.975-3.816 5.313-6.614 7.012-2.796 1.701-5.984 2.55-9.562 2.55-3.577 0-6.764-.849-9.56-2.55-2.798-1.7-5.003-4.037-6.614-7.012-1.611-2.975-2.417-6.339-2.417-10.093 0-3.787.806-7.16 2.417-10.118 1.61-2.956 3.816-5.285 6.614-6.986 2.796-1.699 5.983-2.549 9.56-2.549zm-64.114 0c4.638 0 8.57 1.46 11.792 4.384 3.222 2.922 5.222 6.7 6.002 11.34h-36.015c.78-4.567 2.834-8.33 6.163-11.288 3.328-2.956 7.348-4.435 12.058-4.435zm200.366 0c4.638 0 8.568 1.46 11.79 4.384 3.222 2.922 5.224 6.7 6.003 11.34H534.86c.779-4.567 2.833-8.33 6.162-11.288 3.328-2.956 7.348-4.435 12.059-4.435zm148.3 0c3.576 0 6.766.85 9.562 2.55 2.798 1.701 5.002 4.03 6.614 6.986 1.61 2.956 2.416 6.33 2.416 10.118 0 3.754-.806 7.119-2.416 10.094-1.612 2.974-3.816 5.31-6.614 7.011-2.796 1.7-5.986 2.55-9.562 2.55-3.577 0-6.764-.85-9.56-2.55-2.798-1.7-5.004-4.037-6.614-7.011-1.613-2.975-2.417-6.34-2.417-10.094 0-3.789.804-7.162 2.417-10.118 1.61-2.956 3.816-5.285 6.613-6.986 2.797-1.7 5.984-2.55 9.561-2.55z" fill-rule="nonzero" style="fill:#cfcac9;fill-opacity:1"/><path d="m187.345 108.66 9.992-9.992-9.992-9.992 7.517-11.963-11.964-7.518 4.667-13.337-13.336-4.667 1.581-14.04-14.04-1.583-1.583-14.042-14.04 1.582-4.668-13.337-13.336 4.666-7.52-11.963L108.66 9.99 98.67 0l-9.992 9.992-11.964-7.517-7.517 11.963L55.86 9.771l-4.667 13.337-14.041-1.583-1.582 14.041-14.04 1.582 1.581 14.04-13.338 4.668 4.667 13.337L2.475 76.71l7.518 11.966L0 98.668l9.992 9.993-7.517 11.964 11.964 7.517-4.667 13.337 13.338 4.668-1.582 14.039 14.04 1.583 1.583 14.04 14.041-1.581 4.667 13.335 13.336-4.665 7.518 11.964 11.963-7.518 9.992 9.899 9.992-9.896 11.964 7.517 7.517-11.966 13.338 4.668 4.666-13.337 14.042 1.581 1.581-14.041 14.042-1.582-1.583-14.04 13.338-4.668-4.667-13.338 11.964-7.517z" fill="#b51f08" fill-rule="nonzero"/><path d="M167.114 114.463c0-19.312-15.655-34.967-34.967-34.967-9.592 0-18.282 3.865-24.599 10.121l-.004-.004-8.909 8.91-7.285-7.285c-6.409-7.312-15.81-11.934-26.296-11.934-19.313 0-34.968 15.655-34.968 34.967 0 10.092 4.28 19.178 11.117 25.56l57.466 57.435 56.196-56.233c7.022-6.608 12.25-15.934 12.25-26.57" fill="#fdd49a" fill-rule="nonzero"/><path d="m98.635 98.522-7.285-7.284c-6.41-7.312-15.81-11.935-26.297-11.935-19.312 0-34.967 15.656-34.967 34.967 0 10.092 4.28 19.178 11.117 25.56l57.466 57.436" fill="url(#a)" fill-rule="nonzero"/><path d="m98.669 197.266-.034-98.744" fill="none"/><path d="M108.65 187.336a14.075 14.075 0 0 0-10.001-4.157 14.075 14.075 0 0 0-10.002 4.157c.04 5.49 4.502 9.927 10.001 9.927 5.5 0 9.962-4.439 10.003-9.927M86.967 126.87a7.643 7.643 0 1 1-15.287 0 7.643 7.643 0 1 1 15.287 0" fill="#010007" fill-rule="nonzero"/><path d="M84.345 125.724a2.116 2.116 0 0 1-2.118 2.117 2.117 2.117 0 1 1 0-4.236 2.12 2.12 0 0 1 2.118 2.12" fill="#fffffa" fill-rule="nonzero"/><path d="M125.732 126.87a7.644 7.644 0 1 1-15.288 0 7.644 7.644 0 1 1 15.288 0" fill="#010007" fill-rule="nonzero"/><path d="M123.11 125.724c0 1.172-.95 2.117-2.118 2.117a2.117 2.117 0 1 1 0-4.236 2.12 2.12 0 0 1 2.118 2.12" fill="#fffffa" fill-rule="nonzero"/><defs><linearGradient id="a" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="rotate(-64.537 160.23 25.078) scale(61.7694)"><stop offset="0" stop-color="#fdd49a"/><stop offset="1" stop-color="#dca055"/></linearGradient></defs></svg> \ No newline at end of file
diff --git a/docs/content/images/logo.svg b/docs/content/images/logo.svg
index 8e4071ea..c2b5ef43 100644
--- a/docs/content/images/logo.svg
+++ b/docs/content/images/logo.svg
@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="1564" height="1564" clip-rule="evenodd" fill-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2"><path style="line-height:normal;font-variant-ligatures:normal;font-variant-position:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-alternates:normal;font-variant-east-asian:normal;font-feature-settings:normal;font-variation-settings:normal;text-indent:0;text-align:start;text-decoration-line:none;text-decoration-style:solid;text-decoration-color:#000;text-transform:none;text-orientation:mixed;white-space:normal;shape-padding:0;shape-margin:0;inline-size:0;isolation:auto;mix-blend-mode:normal;solid-color:#000;solid-opacity:1" d="M781.965 0l-79.182 79.19-94.818-59.575-59.574 94.81-105.7-36.99-36.982 105.7-111.283-12.54-12.535 111.276-111.278 12.535 12.541 111.278-105.71 36.988 36.984 105.695-94.815 59.574 59.582 94.832L0 781.961l79.19 79.2-59.577 94.823 94.815 59.573-36.985 105.695 105.707 36.99-12.537 111.264 111.278 12.543 12.535 111.275 111.283-12.535 36.982 105.686 105.694-36.97 59.582 94.821 94.9-59.64 79.096 78.36 79.1-78.343 94.908 59.631 59.572-94.824 105.707 36.988 36.98-105.697 111.284 12.533 12.533-111.283 111.285-12.533-12.543-111.276 105.705-36.99-36.988-105.705 94.814-59.574-59.574-94.813 79.19-79.2-79.188-79.18 59.572-94.813-94.814-59.578 36.99-105.703-105.7-36.983 12.534-111.281-111.275-12.535-12.543-111.283-111.274 12.535-36.99-105.703-105.69 36.986-59.591-94.815-94.82 59.579zm0 77.785l71.305 71.307 85.394-53.656 53.666 85.384 95.172-33.302 33.31 95.185 100.206-11.289 11.296 100.217 100.205 11.289-11.287 100.213 95.182 33.3-33.309 95.188 85.385 53.654-53.648 85.381 71.312 71.309-71.31 71.318 11.666 18.569 41.978 66.812-85.383 53.647 33.311 95.193-95.195 33.31 11.297 100.205-100.215 11.288-11.287 100.216-100.215-11.287-33.301 95.182-95.193-33.31-53.649 85.394-85.289-53.588-18.094 17.922a106.956 106.956 0 0121.871 16.893c-.309 41.33-33.914 74.76-75.33 74.76-41.417 0-75.016-33.42-75.324-74.76a106.994 106.994 0 0122.069-17.01l-17.997-17.828-85.293 53.601-53.65-85.38-95.18 33.29-33.302-95.175-100.217 11.287-11.287-100.205-100.21-11.297 11.29-100.197-95.194-33.311 33.307-95.184-85.385-53.646 53.649-85.39-71.31-71.32 71.32-71.312-53.659-85.4 85.385-53.65-33.305-95.18 95.198-33.313-11.293-100.205 100.207-11.289 11.289-100.207 100.215 11.293 33.302-95.183 95.184 33.308 53.648-85.38 85.391 53.65z" color="#000" font-weight="400" font-family="sans-serif" clip-rule="nonzero" overflow="visible" fill="#fff" fill-rule="nonzero"/><path d="M528.81 636.127c-145.441 0-263.341 117.905-263.341 263.342 0 76 32.23 144.43 83.72 192.49l357.635 357.443c19.257-19.156 45.746-30.984 74.996-30.984 29.295 0 55.839 11.871 75.1 31.09l348.266-348.49c52.88-49.77 92.25-120 92.25-200.1 0-145.437-117.9-263.34-263.34-263.34-72.24 0-137.68 29.112-185.252 76.225l-.033-.035-67.096 67.101-54.863-54.863c-48.267-55.067-119.07-89.88-198.041-89.88zm107.461 300.662c31.804 0 57.57 25.77 57.57 57.57s-25.766 57.569-57.57 57.569c-31.787 0-57.558-25.769-57.558-57.569 0-31.8 25.771-57.57 57.558-57.57zm291.944 0c31.8 0 57.57 25.77 57.57 57.57s-25.77 57.569-57.57 57.569c-31.79 0-57.567-25.769-57.567-57.569 0-31.8 25.777-57.57 57.567-57.57zm-146.27 587.695l.024.023.023-.023h-.047z" fill="#fff" fill-rule="nonzero"/><path d="M674.097 985.728c0 8.82-7.146 15.94-15.95 15.94-8.808 0-15.958-7.12-15.958-15.94 0-8.81 7.15-15.96 15.958-15.96 8.804 0 15.95 7.15 15.95 15.96m291.938 0c0 8.82-7.15 15.94-15.95 15.94-8.81 0-15.96-7.12-15.96-15.94 0-8.81 7.15-15.96 15.96-15.96 8.8 0 15.95 7.15 15.95 15.96" fill="#fffffa" fill-rule="nonzero"/></svg> \ No newline at end of file
+<svg xmlns="http://www.w3.org/2000/svg" width="1564" height="1564" clip-rule="evenodd" fill-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2"><path style="line-height:normal;font-variant-ligatures:normal;font-variant-position:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-alternates:normal;font-variant-east-asian:normal;font-feature-settings:normal;font-variation-settings:normal;text-indent:0;text-align:start;text-decoration-line:none;text-decoration-style:solid;text-decoration-color:#000;text-transform:none;text-orientation:mixed;white-space:normal;shape-padding:0;shape-margin:0;inline-size:0;isolation:auto;mix-blend-mode:normal;solid-color:#000;solid-opacity:1" d="m781.965 0-79.182 79.19-94.818-59.575-59.574 94.81-105.7-36.99-36.982 105.7-111.283-12.54-12.535 111.276-111.278 12.535 12.541 111.278-105.71 36.988 36.984 105.695-94.815 59.574 59.582 94.832L0 781.961l79.19 79.2-59.577 94.823 94.815 59.573-36.985 105.695 105.707 36.99-12.537 111.264 111.278 12.543 12.535 111.275 111.283-12.535 36.982 105.686 105.694-36.97 59.582 94.821 94.9-59.64 79.096 78.36 79.1-78.343 94.908 59.631 59.572-94.824 105.707 36.988 36.98-105.697 111.284 12.533 12.533-111.283 111.285-12.533-12.543-111.276 105.705-36.99-36.988-105.705 94.814-59.574-59.574-94.813 79.19-79.2-79.188-79.18 59.572-94.813-94.814-59.578 36.99-105.703-105.7-36.983 12.534-111.281-111.275-12.535-12.543-111.283-111.274 12.535-36.99-105.703-105.69 36.986-59.591-94.815-94.82 59.579zm0 77.785 71.305 71.307 85.394-53.656 53.666 85.384 95.172-33.302 33.31 95.185 100.206-11.289 11.296 100.217 100.205 11.289-11.287 100.213 95.182 33.3-33.309 95.188 85.385 53.654-53.648 85.381 71.312 71.309-71.31 71.318 11.666 18.569 41.978 66.812-85.383 53.647 33.311 95.193-95.195 33.31 11.297 100.205-100.215 11.288-11.287 100.216-100.215-11.287-33.301 95.182-95.193-33.31-53.649 85.394-85.289-53.588-18.094 17.922a106.956 106.956 0 0 1 21.871 16.893c-.309 41.33-33.914 74.76-75.33 74.76-41.417 0-75.016-33.42-75.324-74.76a106.994 106.994 0 0 1 22.069-17.01l-17.997-17.828-85.293 53.601-53.65-85.38-95.18 33.29-33.302-95.175-100.217 11.287-11.287-100.205-100.21-11.297 11.29-100.197-95.194-33.311 33.307-95.184-85.385-53.646 53.649-85.39-71.31-71.32 71.32-71.312-53.659-85.4 85.385-53.65-33.305-95.18 95.198-33.313-11.293-100.205 100.207-11.289 11.289-100.207 100.215 11.293 33.302-95.183 95.184 33.308 53.648-85.38 85.391 53.65z" color="#000" font-weight="400" font-family="sans-serif" clip-rule="nonzero" overflow="visible" fill="#fff" fill-rule="nonzero"/><path d="M528.81 636.127c-145.441 0-263.341 117.905-263.341 263.342 0 76 32.23 144.43 83.72 192.49l357.635 357.443c19.257-19.156 45.746-30.984 74.996-30.984 29.295 0 55.839 11.871 75.1 31.09l348.266-348.49c52.88-49.77 92.25-120 92.25-200.1 0-145.437-117.9-263.34-263.34-263.34-72.24 0-137.68 29.112-185.252 76.225l-.033-.035-67.096 67.101-54.863-54.863c-48.267-55.067-119.07-89.88-198.041-89.88zm107.461 300.662c31.804 0 57.57 25.77 57.57 57.57s-25.766 57.569-57.57 57.569c-31.787 0-57.558-25.769-57.558-57.569 0-31.8 25.771-57.57 57.558-57.57zm291.944 0c31.8 0 57.57 25.77 57.57 57.57s-25.77 57.569-57.57 57.569c-31.79 0-57.567-25.769-57.567-57.569 0-31.8 25.777-57.57 57.567-57.57zm-146.27 587.695.024.023.023-.023h-.047z" fill="#fff" fill-rule="nonzero"/><path d="M674.097 985.728c0 8.82-7.146 15.94-15.95 15.94-8.808 0-15.958-7.12-15.958-15.94 0-8.81 7.15-15.96 15.958-15.96 8.804 0 15.95 7.15 15.95 15.96m291.938 0c0 8.82-7.15 15.94-15.95 15.94-8.81 0-15.96-7.12-15.96-15.94 0-8.81 7.15-15.96 15.96-15.96 8.8 0 15.95 7.15 15.95 15.96" fill="#fffffa" fill-rule="nonzero"/></svg> \ No newline at end of file
diff --git a/docs/content/index.md b/docs/content/index.md
index df961b02..d2ab656c 100644
--- a/docs/content/index.md
+++ b/docs/content/index.md
@@ -1,6 +1,7 @@
# Welcome to the HedgeDoc Documentation
-![HedgeDoc Logo](images/hedgedoc_logo_horizontal.svg)
+<img alt="HedgeDoc Logo" title="HedgeDoc Logo" class="light-mode-only" src="images/hedgedoc_logo_black.svg">
+<img alt="HedgeDoc Logo" title="HedgeDoc Logo" class="dark-mode-only" src="images/hedgedoc_logo_white.svg">
HedgeDoc lets you create real-time collaborative markdown notes. You can test-drive
it by visiting our [HedgeDoc demo server][hedgedoc-demo].
diff --git a/docs/content/setup/docker.md b/docs/content/setup/docker.md
index f6aeb833..11ff9b02 100644
--- a/docs/content/setup/docker.md
+++ b/docs/content/setup/docker.md
@@ -1,20 +1,93 @@
# HedgeDoc Docker Image
-[![Try in PWD](https://cdn.rawgit.com/play-with-docker/stacks/cff22438/assets/images/button.png)](http://play-with-docker.com?stack=https://github.com/hedgedoc/container/raw/master/docker-compose.yml&stack_name=hedgedoc)
+!!! info "Requirements on your server"
+ - [Git](https://git-scm.com/)
+ - [Docker](https://docs.docker.com/get-docker/) 17.03.1 or higher
+ - [Docker Compose](https://docs.docker.com/compose/install/)
-## Debian-based version
+The official docker images are [available on quay.io](https://quay.io/repository/hedgedoc/hedgedoc).
+We currently only support the `amd64` architecture.
-[![Docker Repository on Quay](https://quay.io/repository/hedgedoc/hedgedoc/status "Docker Repository on Quay")](https://quay.io/repository/hedgedoc/hedgedoc)
-## Alpine-based version
+The easiest way to get started with HedgeDoc and Docker is to use the following `docker-compose.yml`:
-[![Docker Repository on Quay](https://quay.io/repository/hedgedoc/hedgedoc/status "Docker Repository on Quay")](https://quay.io/repository/hedgedoc/hedgedoc)
+!!! warning
+ This is a minimal example to get started quickly and not intended for production use.
-The easiest way to setup HedgeDoc using docker are using the following three commands:
+```yaml
+version: '3'
+services:
+ database:
+ image: postgres:9.6-alpine
+ environment:
+ - POSTGRES_USER=hedgedoc
+ - POSTGRES_PASSWORD=password
+ - POSTGRES_DB=hedgedoc
+ volumes:
+ - database:/var/lib/postgresql/data
+ restart: always
+ app:
+ # Make sure to use the latest release from https://hedgedoc.org/latest-release
+ image: quay.io/hedgedoc/hedgedoc:1.7.2
+ environment:
+ - CMD_DB_URL=postgres://hedgedoc:password@database:5432/hedgedoc
+ - CMD_DOMAIN=localhost
+ - CMD_URL_ADDPORT=true
+ volumes:
+ - uploads:/hedgedoc/public/uploads
+ ports:
+ - "3000:3000"
+ restart: always
+ depends_on:
+ - database
+volumes:
+ database:
+ uploads:
+```
+After executing `docker-compose up`, HedgeDoc should be available at [http://127.0.0.1:3000](http://127.0.0.1:3000).
+You can now continue to configure your container with environment variables.
+Check out [the configuration docs](/configuration) for more details.
+
+## Upgrading
+
+!!! warning
+ Before you upgrade, **always read the release notes**.
+ You can find them on our [releases page](https://hedgedoc.org/releases/).
+
+!!! info "Upgrading to 1.7"
+ Together with changing the name to "HedgeDoc" the default username,
+ password and database name have been changed in `docker-compose.yml`.
+
+ In order to migrate the existing database to the new default credentials, run
+ ```shell
+ docker-compose exec database createuser --superuser -Uhackmd postgres
+ docker-compose exec database psql -Upostgres -c "alter role hackmd rename to hedgedoc; alter role hedgedoc with password 'password'; alter database hackmd rename to hedgedoc;"
+ ```
+ before running `docker-compose up`.
+
+You can upgrade to the latest release by stopping the containers and changing the referenced image version in `docker-compose.yml`.
+Then run `docker-compose up` to start HedgeDoc again.
+
+### Migrating from CodiMD & HackMD
+
+If you currently use CodiMD or HackMD, you should be able to swap the docker image for ours.
+See [the general migration hints](/setup/getting-started/#migrating-from-codimd-hackmd) for compatibility details.
+
+
+## Backup
+
+If you use a PostgreSQL database, you can leverage this command to create a backup:
+
+```shell
+ docker-compose exec database pg_dump hedgedoc -U hedgedoc > backup.sql
+```
+
+
+## Restore
+
+If you want to restore your PostgreSQL backup, run these commands before starting the application for the first time:
-```sh
-git clone https://github.com/hedgedoc/container.git hedgedoc-container
-cd hedgedoc-container
-docker-compose up
+```shell
+docker-compose up -d database
+cat backup.sql | docker exec -i $(docker-compose ps -q database) psql -U hedgedoc
```
-Read more about it in the [container repository](https://github.com/hedgedoc/container).
diff --git a/docs/content/setup/getting-started.md b/docs/content/setup/getting-started.md
index 41426514..2b1f8653 100644
--- a/docs/content/setup/getting-started.md
+++ b/docs/content/setup/getting-started.md
@@ -6,5 +6,28 @@ 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 <a href="http://social.codimd.org/" target="_blank" rel="noreferer noopener">:fontawesome-brands-mastodon:{: .mastodon }Mastodon</a> or <a href="http://social.codimd.org/twitter" target="_blank" rel="noreferer noopener">:fontawesome-brands-twitter:{: .twitter }Twitter</a> for updates.
+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/).
+
+## 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/).
diff --git a/docs/content/setup/manual-setup.md b/docs/content/setup/manual-setup.md
index 4d03b752..acc739ca 100644
--- a/docs/content/setup/manual-setup.md
+++ b/docs/content/setup/manual-setup.md
@@ -1,41 +1,141 @@
# Manual Installation
-## Requirements on your server
-
-- Node.js 10.13 or up
-- Database (PostgreSQL, MySQL, MariaDB, SQLite, MSSQL)
- The database must use charset `utf8`. This is typically the default in PostgreSQL and SQLite.
- In MySQL and MariaDB UTF-8 might need to be set with `alter database <DBNAME> character set utf8 collate utf8_bin;`
- Be aware of older MySQL and MariaDB versions which sometimes use shorter representations of UTF-8 than 4 bytes.
- This can break if symbols with more bytes are used.
- You can use `alter database <DBNAME> character set utf8mb4 COLLATE utf8mb4_unicode_ci` to be on the safe side.
-- NPM (and its dependencies, [node-gyp](https://github.com/nodejs/node-gyp#installation))
-- Yarn
-- Bash (for the setup script)
-- For **building** the HedgeDoc frontend you need a machine with at least **2 GB** RAM.
- - Starting with release 1.7 the release tarball includes the frontend, so building it yourself is not necessary.
-
-## Instructions
-
-1. Check if you meet the [requirements at the top of this document](#requirements-on-your-server).
-2. Download a [release](https://github.com/hedgedoc/hedgedoc/releases) tarball and extract it.
- Alternatively, you can use Git to clone the repository and checkout a release, e.g. with `git clone -b 1.7.2 https://github.com/hedgedoc/hedgedoc.git`.
-3. Enter the directory and type `bin/setup`, which will install the dependencies and create configs.
-4. Modify the file named `config.json` or configure HedgeDoc through environment variables which will overwrite the configs, see docs [here](../configuration.md).
-5. **If using the release tarball for 1.7.0 or newer, this step can be skipped.**
- Build the frontend bundle by `yarn run build` (use `yarn run dev` if you are in development)
-6. It is recommended to start your server manually once: `NODE_ENV=production yarn start`, this way it's easier to see warnings or errors that might occur (leave out `NODE_ENV=production` for development).
-7. Run the server as you like (node, forever, pm2, SystemD, Init-Scripts)
-
-## How to upgrade your installation
-
-If you are upgrading HedgeDoc from an older version, follow these steps:
-
-1. Check if you meet the [requirements at the top of this document](#requirements-on-your-server).
-2. Verify which version you were running before and take a look at [migrations and breaking changes](../guides/migrations-and-breaking-changes.md) to see if additional steps, or configuration changes are necessary!
-3. Fully stop your old HedgeDoc server.
-4. `git pull` or unzip a new release in the directory.
+!!! info "Requirements on your server"
+ - Node.js 10.13 or higher
+ - Database (PostgreSQL, MySQL, MariaDB, SQLite, MSSQL)
+ The database must use charset `utf8`. This is typically the default in PostgreSQL and SQLite.
+ In MySQL and MariaDB UTF-8 might need to be set with `alter database <DBNAME> character set utf8 collate utf8_bin;`
+ Be aware of older MySQL and MariaDB versions which sometimes use shorter representations of UTF-8 than 4 bytes.
+ This can break if symbols with more bytes are used.
+ You can use `alter database <DBNAME> character set utf8mb4 COLLATE utf8mb4_unicode_ci` to be on the safe side.
+ - NPM (and its dependencies, [node-gyp](https://github.com/nodejs/node-gyp#installation))
+ - [Yarn Classic](https://classic.yarnpkg.com) 1.22 or higher (Yarn 2 is currently not supported)
+ - Bash (for the setup script)
+ - For **building** the HedgeDoc frontend you need a machine with at least **2 GB** RAM.
+ - Starting with release 1.7 the release tarball includes the prebuilt frontend, so building it yourself is not necessary.
+
+1. Check if you meet the [requirements at the top of this document](#manual-installation).
+2. Download the [latest release](https://hedgedoc.org/latest-release/) and extract it.
+ <small>Alternatively, you can use Git to clone the repository and checkout a release, e.g. with `git clone -b 1.7.2 https://github.com/hedgedoc/hedgedoc.git`.</small>
+3. Enter the directory and execute `bin/setup`, which will install the dependencies and create example configs.
+4. Configure HedgeDoc: To get started, you can use this minimal `config.json`:
+ ```json
+ {
+ "production": {
+ "db": {
+ "dialect": "sqlite",
+ "storage": "./db.hedgedoc.sqlite"
+ },
+ "urlAddPort": true,
+ "domain": "localhost"
+ }
+ }
+ ```
+ It's also possible to use environment variables.
+ For details, have a look at [the configuration documentation](../configuration.md).
+5. *:octicons-light-bulb-16: If you use the release tarball for 1.7.0 or newer, this step can be skipped.*
+ Build the frontend bundle by running `yarn run build`.
+6. Modify the file named `.sequelizerc`, change the value of the variable `url` to your db connection string. For example:
+ - `postgres://username:password@localhost:5432/hedgedoc`
+ - `mysql://username:password@localhost:3306/hedgedoc`
+ - `sqlite:///opt/hedgedoc/hedgedoc.sqlite` (note that you need to use an absolute path to the SQLite file)
+7. It is recommended to start your server manually once:
+ ```shell
+ NODE_ENV=production yarn start
+ ```
+ This way it's easier to see warnings or errors that might occur.
+ <small>You can leave out `NODE_ENV=production` for development.</small>
+8. If you use the example config, HedgeDoc should now be available at [http://127.0.0.1:3000](http://127.0.0.1:3000).
+9. Run the server as you like (node, forever, pm2, systemd, Init-Scripts).
+ See [below](#systemd-unit-example) for an example using systemd.
+
+## Upgrading
+
+!!! warning
+ Before you upgrade, **always read the release notes**.
+ You can find them on our [releases page](https://hedgedoc.org/releases/).
+
+If you want to upgrade HedgeDoc from an older version, follow these steps:
+
+1. Check if you still meet the [requirements at the top of this document](#requirements-on-your-server).
+2. Ensure you read the [release notes](https://hedgedoc.org/releases/) of all versions between your current version
+ and the latest release.
+2. Fully stop your old HedgeDoc server.
+3. [Download](https://hedgedoc.org/latest-release/) the new release and extract it over the old directory.
+ <small>If you use Git, you can check out the new tag with e.g. `git fetch origin && git checkout 1.7.2`</small>
5. Run `bin/setup`. This will take care of installing dependencies. It is safe to run on an existing installation.
-6. Build front-end bundle by `yarn run build` (use `yarn run dev` if you are in development).
-7. It is recommended to start your server manually once: `NODE_ENV=production yarn start`, this way it's easier to see warnings or errors that might occur (leave out `NODE_ENV=production` for development).
+6. *:octicons-light-bulb-16: If you used the release tarball for 1.7.0 or newer, this step can be skipped.*
+ Build the frontend bundle by running `yarn run build`.
+7. It is recommended to start your server manually once:
+ ```shell
+ NODE_ENV=production yarn start
+ ```
+ This way it's easier to see warnings or errors that might occur.
8. You can now restart the HedgeDoc server!
+
+## Systemd Unit Example
+Using the unit file below, you can run HedgeDoc as a systemd service.
+
+!!! warning
+ - In this example, you must configure HedgeDoc using the `config.json` file and the
+ `production` key.
+ - Make sure the user and group `hedgedoc` exists and has appropriate permissions in the
+ directory you installed HedgeDoc in or change the `User` and `Group` settings in the unit
+ file.
+ - Make sure `WorkingDirectory` points to the directory you installed HedgeDoc in.
+ - Make sure `ReadWritePaths` contains all directories HedgeDoc might write to. This may
+ include the `public/uploads` folder if you configured local storage. If you use SQLite, you
+ must also include the directory where the database file is saved. **Do not save the SQLite
+ file in the root directory of the HedgeDoc installation**, but create a subfolder like `db`!
+ - If you use an external database like PostgreSQL or MariaDB, make sure to add a corresponding
+ `After` statement.
+
+```ini
+[Unit]
+Description=HedgeDoc - The best platform to write and share markdown.
+Documentation=https://docs.hedgedoc.org/
+After=network.target
+# Uncomment if you use MariaDB/MySQL
+# After=mysql.service
+# Uncomment if you use PostgreSQL
+# After=postgresql.service
+
+[Service]
+Type=exec
+Environment=NODE_ENV=production
+Restart=always
+RestartSec=2s
+ExecStart=/usr/bin/yarn start --production
+CapabilityBoundingSet=
+NoNewPrivileges=true
+PrivateDevices=true
+RemoveIPC=true
+LockPersonality=true
+ProtectControlGroups=true
+ProtectKernelTunables=true
+ProtectKernelModules=true
+ProtectKernelLogs=true
+ProtectClock=true
+ProtectHostname=true
+ProtectProc=noaccess
+RestrictRealtime=true
+RestrictSUIDSGID=true
+RestrictNamespaces=true
+RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6
+ProtectSystem=strict
+ProtectHome=true
+PrivateTmp=true
+SystemCallArchitectures=native
+SystemCallFilter=@system-service
+
+# You may have to adjust these settings
+User=hedgedoc
+Group=hedgedoc
+WorkingDirectory=/opt/hedgedoc
+
+# Example: local storage for uploads and SQLite
+# ReadWritePaths=/opt/hedgedoc/public/uploads /opt/hedgedoc/db
+
+[Install]
+WantedBy=multi-user.target
+```
diff --git a/docs/content/theme/styles/hedgedoc-custom.css b/docs/content/theme/styles/hedgedoc-custom.css
index e3c52757..97baeed5 100644
--- a/docs/content/theme/styles/hedgedoc-custom.css
+++ b/docs/content/theme/styles/hedgedoc-custom.css
@@ -1,9 +1,41 @@
+[data-md-color-scheme="slate"][data-md-color-primary=hedgedoc] {
+ --md-hue: 8;
+ --md-default-fg-color: hsla(var(--md-hue), 20%, 80%, 1);
+ --md-default-fg-color--light: hsla(var(--md-hue), 20%, 80%, 1);
+ --md-default-fg-color--lighter: hsla(var(--md-hue), 20%, 80%, 0.5);
+ --md-default-fg-color--lightest: hsla(var(--md-hue), 20%, 80%, 0.2);
+
+ --md-default-bg-color: hsla(var(--md-hue), 0%, 5%, 1);
+ --md-default-bg-color--light: hsla(var(--md-hue), 0%, 5%, 0.54);
+ --md-default-bg-color--lighter: hsla(var(--md-hue), 0%, 5%, 0.26);
+ --md-default-bg-color--lightest: hsla(var(--md-hue), 0%, 5%, 0.07);
+
+ --md-typeset-color: hsl(var(--md-hue), 5%, 80%);
+ --md-typeset-a-color: hsl(var(--md-hue), 92%, 67%, 1);
+ --md-primary-fg-color: hsl(var(--md-hue), 92%, 25%, 1);
+ --md-table-header-fg-color: var(--md-typeset-color);
+ --md-table-header-bg-color: hsla(var(--md-hue), 0%, 20%, 1);
+
+ --md-code-fg-color: hsla(var(--md-hue),0%,86%,1);
+ --md-code-bg-color: hsla(var(--md-hue),0%,15%,1);
+}
+
+[data-md-color-primary=hedgedoc] .md-typeset table:not([class]) th {
+ background-color: var(--md-table-header-bg-color);
+ color: var(--md-table-header-fg-color);
+}
+
[data-md-color-primary=hedgedoc] {
- --md-primary-fg-color: #b51f08;
- --md-primary-fg-color--light: #b51f08;
- --md-primary-fg-color--dark: #b51f08;
- --md-primary-bg-color: hsla(0, 0%, 100%, 1);
- --md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7);
+ --md-hue: 8;
+ --md-primary-fg-color: hsl(var(--md-hue), 92%, 37%, 1);
+ --md-primary-fg-color--dark: var(--md-primary-fg-color);
+ --md-primary-fg-color--light: var(--md-primary-fg-color);
+ --md-primary-bg-color: hsla(0, 15%, 100%, 1);
+ --md-footer-bg-color: hsla(var(--md-hue), 0%, 12%, 1);
+ --md-footer-bg-color--dark: hsla(var(--md-hue), 0%, 16%, 1);
+
+ --md-table-header-fg-color: var(--md-default-bg-color);
+ --md-table-header-bg-color: var(--md-default-fg-color--light);
}
[data-md-color-accent=hedgedoc] {
@@ -24,3 +56,11 @@
.mastodon {
color: #2b90d9;
}
+
+[data-md-color-scheme="slate"] .light-mode-only {
+ display: none;
+}
+
+[data-md-color-scheme="light"] .dark-mode-only {
+ display: none;
+}
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 5b04cc40..f78479d5 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -36,7 +36,6 @@ nav:
- MinIO: guides/minio-image-upload.md
- S3: guides/s3-image-upload.md
- Migrate from Etherpad: guides/migrate-etherpad.md
- - Breaking Changes: guides/migrations-and-breaking-changes.md
- Migration Troubleshooting: guides/migration-troubleshooting.md
- Terms of Use Setup: guides/providing-terms.md
- Configuration: configuration.md
@@ -60,15 +59,28 @@ markdown_extensions:
emoji_generator: !!python/name:materialx.emoji.to_svg
- attr_list
- footnotes
+ - admonition
theme:
name: 'material'
language: en
favicon: images/favicon.png
logo: images/logo.svg
palette:
- scheme: light
- primary: 'hedgedoc'
- accent: 'hedgedoc'
+ - media: "(prefers-color-scheme: light)"
+ scheme: light
+ primary: 'hedgedoc'
+ accent: 'hedgedoc'
+ toggle:
+ icon: material/lightbulb-outline
+ name: Switch to dark mode
+ # Dark mode
+ - media: "(prefers-color-scheme: dark)"
+ scheme: slate
+ primary: 'hedgedoc'
+ accent: 'hedgedoc'
+ toggle:
+ icon: material/lightbulb
+ name: Switch to light mode
features:
- navigation.tabs
- navigation.sections
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 7e1e4f85..a9d48e08 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,4 +1,4 @@
mkdocs==1.1.2
-mkdocs-material==7.1.0
+mkdocs-material==7.1.2
pymdown-extensions==8.1.1
mdx_truly_sane_lists==1.2
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-18 22:51:34 +0000