From 038c1b48689e1e852074f1929eb2e009ed865f74 Mon Sep 17 00:00:00 2001 From: David Mehren Date: Thu, 12 Aug 2021 22:22:39 +0200 Subject: [PATCH] Port over the FAQ page from hedgedoc.org Signed-off-by: David Mehren --- docs/content/faq.md | 36 ++++++++++++++++++++++++++++++++++++ docs/mkdocs.yml | 2 +- 2 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 docs/content/faq.md diff --git a/docs/content/faq.md b/docs/content/faq.md new file mode 100644 index 000000000..5736f7f03 --- /dev/null +++ b/docs/content/faq.md @@ -0,0 +1,36 @@ +This page collects Frequently Asked Questions of the community. +If you have any questions that aren't answered here, feel free to ask us on [Matrix][matrix.org-url] or stop by our [community forums][hedgedoc-community]. + +[matrix.org-url]: https://chat.hedgedoc.org +[hedgedoc-community]: https://community.hedgedoc.org + +## Why is CodiMD now called HedgeDoc? +The short version: There were two CodiMD-projects on GitHub, the community-driven fork and the original project maintained by the HackMD-team. +To solve this naming conflict, our community-driven version was renamed to HedgeDoc. +For a full writeup, check out the [history overview](https://hedgedoc.org/history/). + + +## Can I run multiple instances on the same database? +No. The HedgeDoc server process is not entirely stateless and therefore running more than one instance will result in missing/broken content for users. +In order to solve issues like HA-capabilities, please use a high level orchestrator that makes sure that always 1 instance is running on your infrastructure and that the database is available. +The server process usually starts within seconds and therefore the possible downtime should be minimal. + + +## Why was the PDF Export feature removed? +We used a headless Chromium instance to generate the PDFs, but that led to some security vulnerabilities and was therefore deactivated. +There are currently plans to re-add this feature in a safe way, but this will most likely take some time and can be expected at the earliest with HedgeDoc 2.1 (but could also take longer). +In the meantime you can use your browsers print to PDF Feature. +This [page](https://www.digitaltrends.com/computing/how-to-save-a-webpage-as-a-pdf/) explains how to do that for multiple browsers. + + +## Why can't I embed some PDFs? +Many servers don't allow the embedding of their content on arbitrary sites. + +For a more technical explanation: +The `X-Frame-Options` header can be used to specify if a given webpage can be embedded. +For security reasons this header is often set to `SAMEORIGIN`, which disallows embedding on other origins. +To be able to embed a PDF inside a HedgeDoc note, the server that hosts the PDF must either send no `X-Frame-Options` +header (which might be insecure) or include the URI of your HedgeDoc instance in an `ALLOW-FROM` statement. +See [Mozillas docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) for more details. +Also note that the `X-Frame-Options` header [is being obsoleted](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/frame-ancestors) +by the `frame-ancestors` statement in the `Content-Security-Policy` header. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 46cea7b51..cdd5322b1 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -48,7 +48,7 @@ nav: - 'Operational Transformation': dev/ot.md - Webpack: dev/webpack.md - 'Documentation': dev/documentation.md - - FAQ: https://hedgedoc.org/faq + - FAQ: faq.md markdown_extensions: - toc: permalink: true