Browse Source

Added FAQ to docs

Jamie Curnow 5 years ago
parent
commit
3e912a7474
4 changed files with 21 additions and 4 deletions
  1. 1 0
      docs/.vuepress/config.js
  2. 3 3
      docs/advanced-config/README.md
  3. 16 0
      docs/faq/README.md
  4. 1 1
      docs/setup/README.md

+ 1 - 0
docs/.vuepress/config.js

@@ -47,6 +47,7 @@ module.exports = {
 					["/screenshots/", "Screenshots"],
 					["/screenshots/", "Screenshots"],
 					["/setup/", "Setup Instructions"],
 					["/setup/", "Setup Instructions"],
 					["/advanced-config/", "Advanced Configuration"],
 					["/advanced-config/", "Advanced Configuration"],
+					["/faq/", "Frequently Asked Questions"],
 					["/third-party/", "Third Party"]
 					["/third-party/", "Third Party"]
 				]
 				]
 			}
 			}

+ 3 - 3
docs/advanced-config/README.md

@@ -1,6 +1,6 @@
 # Advanced Configuration
 # 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:
 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.
 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.
 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
 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`.
 value by specifying it as a Docker environment variable. The default if not specified is `deny`.

+ 16 - 0
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=).

+ 1 - 1
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
 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.
 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,
 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=).
 [create a feature request](https://github.com/jc21/nginx-proxy-manager/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=).