From 3e912a74749fad4d2a6513e8c7d2d5289bfe36c3 Mon Sep 17 00:00:00 2001
From: Jamie Curnow <jc@jc21.com>
Date: Wed, 20 May 2020 21:14:00 +1000
Subject: [PATCH] Added FAQ to docs
---
docs/.vuepress/config.js | 1 +
docs/advanced-config/README.md | 6 +++---
docs/faq/README.md | 16 ++++++++++++++++
docs/setup/README.md | 2 +-
4 files changed, 21 insertions(+), 4 deletions(-)
create mode 100644 docs/faq/README.md
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
index 8ddfd43..d98ccdb 100644
--- a/docs/.vuepress/config.js
+++ b/docs/.vuepress/config.js
@@ -47,6 +47,7 @@ module.exports = {
["/screenshots/", "Screenshots"],
["/setup/", "Setup Instructions"],
["/advanced-config/", "Advanced Configuration"],
+ ["/faq/", "Frequently Asked Questions"],
["/third-party/", "Third Party"]
]
}
diff --git a/docs/advanced-config/README.md b/docs/advanced-config/README.md
index a53fc6d..30daf25 100644
--- a/docs/advanced-config/README.md
+++ b/docs/advanced-config/README.md
@@ -1,6 +1,6 @@
# Advanced Configuration
-### Disabling IPv6
+## Disabling IPv6
On some docker hosts IPv6 may not be enabled. In these cases, the following message may be seen in the log:
@@ -14,7 +14,7 @@ The easy fix is to add a Docker environment variable to the Nginx Proxy Manager
```
-### Custom Nginx Configurations
+## Custom Nginx Configurations
If you are a more advanced user, you might be itching for extra Nginx customizability.
@@ -33,7 +33,7 @@ You can add your custom configuration snippet files at `/data/nginx/custom` as f
Every file is optional.
-### X-FRAME-OPTIONS Header
+## X-FRAME-OPTIONS Header
You can configure the [`X-FRAME-OPTIONS`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) header
value by specifying it as a Docker environment variable. The default if not specified is `deny`.
diff --git a/docs/faq/README.md b/docs/faq/README.md
new file mode 100644
index 0000000..7a2bae1
--- /dev/null
+++ b/docs/faq/README.md
@@ -0,0 +1,16 @@
+# FAQ
+
+## Do I have to use Docker?
+
+Yes, that's how this project is packaged.
+
+This makes it easier to support the project when I have control over the version of Nginx and NodeJS
+being used. In future this could change if the backend was no longer using NodeJS and it's long list
+of dependencies.
+
+
+## Can I run it on a Raspberry Pi?
+
+Yes! The docker image is multi-arch and is built for a variety of architectures. If yours is
+[not listed](https://hub.docker.com/r/jc21/nginx-proxy-manager/tags) please open a
+[GitHub issue](https://github.com/jc21/nginx-proxy-manager/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=).
diff --git a/docs/setup/README.md b/docs/setup/README.md
index f6c8f94..3acdc7b 100644
--- a/docs/setup/README.md
+++ b/docs/setup/README.md
@@ -103,7 +103,7 @@ The docker images support the following architectures:
The docker images are a manifest of all the architecture docker builds supported, so this means
you don't have to worry about doing anything special and you can follow the common instructions above.
-Check out the [dockerhub tags](https://cloud.docker.com/repository/registry-1.docker.io/jc21/nginx-proxy-manager/tags)
+Check out the [dockerhub tags](https://hub.docker.com/r/jc21/nginx-proxy-manager/tags)
for a list of supported architectures and if you want one that doesn't exist,
[create a feature request](https://github.com/jc21/nginx-proxy-manager/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=).