refactor(docs): fix links

Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
Philip Molares
2026-06-11 16:06:37 +02:00
committed by Erik Michelson
parent 523cb8ea1f
commit d7c1e45814
7 changed files with 13 additions and 13 deletions

View File

@@ -47,17 +47,17 @@ If you still want to allow embedding via iframe, ensure that:
- `cookiePolicy` / `CMD_COOKIE_POLICY` is set to `none` (Otherwise you will get a `AUTH failed: No cookie transmitted` error.) - `cookiePolicy` / `CMD_COOKIE_POLICY` is set to `none` (Otherwise you will get a `AUTH failed: No cookie transmitted` error.)
- `csp.allowFraming` / `CMD_CSP_ALLOW_FRAMING` is set to `true` - `csp.allowFraming` / `CMD_CSP_ALLOW_FRAMING` is set to `true`
See also the [configuration docs](/configuration/#web-security-aspects) for more information about these options. See also the [configuration docs](configuration.md#web-security-aspects) for more information about these options.
## I can't upload images or the upload gets stuck ## I can't upload images or the upload gets stuck
This problem is typically accompanied by the error `Invalid URL: /uploads/` in the log and is often caused by a missing This problem is typically accompanied by the error `Invalid URL: /uploads/` in the log and is often caused by a missing
`domain` / `CMD_DOMAIN` config option or an incorrect reverse proxy config. `domain` / `CMD_DOMAIN` config option or an incorrect reverse proxy config.
Have a look at our [reverse proxy documentation](https://docs.hedgedoc.org/guides/reverse-proxy/) Have a look at our [reverse proxy documentation](guides/reverse-proxy.md)
and make sure that `protocolUseSSL` / `CMD_PROTOCOL_USESSL` is set to `true` if you serve HedgeDoc via HTTPS. and make sure that `protocolUseSSL` / `CMD_PROTOCOL_USESSL` is set to `true` if you serve HedgeDoc via HTTPS.
## HedgeDoc fails executing migrations and does not start ## HedgeDoc fails executing migrations and does not start
Unfortunately, older versions of HedgeDoc had some bugs regarding migrations and didn't always record that a migration was executed. Unfortunately, older versions of HedgeDoc had some bugs regarding migrations and didn't always record that a migration was executed.
Have a look at the *[Troubleshooting Migrations](/guides/migration-troubleshooting/)* guide for more information. Have a look at the *[Troubleshooting Migrations](guides/migration-troubleshooting.md)* guide for more information.
## Why does my interface look weird? ## Why does my interface look weird?
@@ -76,4 +76,4 @@ You should check the following settings (or their corresponding environment vari
- `protocolUseSSL` (env: `CMD_PROTOCOL_USESSL`) - `protocolUseSSL` (env: `CMD_PROTOCOL_USESSL`)
- `urlAddPort` (env: `CMD_URL_ADDPORT`) - `urlAddPort` (env: `CMD_URL_ADDPORT`)
Check [the reverse proxy guide](../guides/reverse-proxy/#configure-asset-link-generation) for an explanation. Check [the reverse proxy guide](guides/reverse-proxy.md#configure-asset-link-generation) for an explanation.

View File

@@ -63,7 +63,7 @@ In order to view the images uploaded to HedgeDoc the storage bucket needs to be
## Configure HedgeDoc ## Configure HedgeDoc
Set the following environment variables (or the [corresponding config.json values](/configuration/#amazon-s3)): Set the following environment variables (or the [corresponding config.json values](../../configuration.md#amazon-s3)):
```env ```env
CMD_IMAGE_UPLOAD_TYPE="s3" CMD_IMAGE_UPLOAD_TYPE="s3"

View File

@@ -16,6 +16,6 @@ If you have any questions that aren't answered here, feel free to ask us on [Mat
[hedgedoc-demo]: https://demo.hedgedoc.org [hedgedoc-demo]: https://demo.hedgedoc.org
[hedgedoc-history]: https://hedgedoc.org/history [hedgedoc-history]: https://hedgedoc.org/history
[hedgedoc-history-details]: https://hedgedoc.org/history/details [hedgedoc-history-details]: https://hedgedoc.org/history/details
[hedgedoc-faq]: /faq [hedgedoc-faq]: faq.md
[matrix.org-url]: https://chat.hedgedoc.org [matrix.org-url]: https://chat.hedgedoc.org
[hedgedoc-community]: https://community.hedgedoc.org [hedgedoc-community]: https://community.hedgedoc.org

View File

@@ -25,7 +25,7 @@ title: meta title
## description ## description
This option will set the note description as a `<meta name="description">` tag. This only affects the [Publish](../features#Share-Notes) function. This option will set the note description as a `<meta name="description">` tag. This only affects the Publish function.
> default: not set > default: not set

View File

@@ -13,7 +13,7 @@ The easiest way to get started with HedgeDoc and Docker is to use the following
!!! warning !!! warning
This is a minimal example to get started quickly and not intended for production use. This is a minimal example to get started quickly and not intended for production use.
For more information about production use see [this guide](/guides/production-ready). For more information about production use see [this guide](../guides/production-ready.md).
```yaml ```yaml
version: '3' version: '3'
@@ -47,7 +47,7 @@ volumes:
``` ```
After executing `docker-compose up`, HedgeDoc should be available at [http://localhost:3000](http://localhost:3000). After executing `docker-compose up`, HedgeDoc should be available at [http://localhost:3000](http://localhost:3000).
You can now continue to configure your container with environment variables. You can now continue to configure your container with environment variables.
Check out [the configuration docs](/configuration) for more details. Check out [the configuration docs](../configuration.md) for more details.
## File Permissions ## File Permissions
@@ -83,7 +83,7 @@ Then run `docker-compose up` to start HedgeDoc again.
### Migrating from CodiMD & HackMD ### Migrating from CodiMD & HackMD
If you currently use CodiMD or HackMD, you should be able to swap the docker image for ours. 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. See [the general migration hints](../setup/getting-started.md#migrating-from-codimd-hackmd) for compatibility details.
## Backup ## Backup

View File

@@ -5,8 +5,8 @@ To set up your instance follow these steps:
1. Choose an installation method and follow the instructions 1. Choose an installation method and follow the instructions
2. [Configure your reverse proxy](https://docs.hedgedoc.org/guides/reverse-proxy/) 2. [Configure your reverse proxy](https://docs.hedgedoc.org/guides/reverse-proxy/)
3. [Configure HedgeDoc](https://docs.hedgedoc.org/configuration/) 3. [Configure HedgeDoc](../configuration.md)
4. If you didn't disable [local accounts](/configuration/#email-local-account), you can use the "Sign In" button to 4. If you didn't disable [local accounts](../configuration.md#email-local-account), you can use the "Sign In" button to
create an account, login and start using HedgeDoc. create an account, login and start using HedgeDoc.
Follow us on <a href="https://social.hedgedoc.org/" target="_blank" rel="noreferer noopener">:fontawesome-brands-mastodon:{: .mastodon }Mastodon</a> for updates. Follow us on <a href="https://social.hedgedoc.org/" target="_blank" rel="noreferer noopener">:fontawesome-brands-mastodon:{: .mastodon }Mastodon</a> for updates.

View File

@@ -56,7 +56,7 @@
If you want to upgrade HedgeDoc from an older version, follow these steps: 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). 1. Check if you still meet the [requirements at the top of this document](#manual-installation).
2. Ensure you read the [release notes](https://hedgedoc.org/releases/) of all versions between your current version 2. Ensure you read the [release notes](https://hedgedoc.org/releases/) of all versions between your current version
and the latest release. and the latest release.
2. Fully stop your old HedgeDoc server. 2. Fully stop your old HedgeDoc server.