Renamed "Access Restriction" to indicate that authentication is disab…

…led, changed documentation #221
Forceu · Dec 12, 2024 · 79961f0 · 79961f0
1 parent 61a8c8d
commit 79961f0
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 5 deletions.
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -7,6 +7,8 @@ Examples
 
 
 
+.. _nginx_config:
+
 *********************************
 Nginx  Configuration
 *********************************

diff --git a/docs/setup.rst b/docs/setup.rst
@@ -132,7 +132,7 @@ The following configuration can be set:
 Authentication
 """"""""""""""
 
-This menu guides you through the authentication setup, where you select how an admin user logs in (only user that can upload files)
+This menu guides you through the authentication setup, where you select how an admin user logs in (only user that can upload files). It is possible to disable authentication completely, but strongly discouraged.
 
 
 Username / Password 
@@ -220,8 +220,8 @@ Enter the key of the header that returns the username. For Authelia this would b
 Separate users with a semicolon or leave blank to allow any authenticated user, e.g. ``gokapiuser@gmail.com;companyadmin@gmail.com``
 
 
-Access Restriction
-************************
+Disabled / Access Restriction
+*************************************
 
 Only use this if you are running Gokapi behind a reverse proxy that is capable of authenticating users, e.g. by using Authelia or Authentik.
 
@@ -334,6 +334,15 @@ If you are using Docker, shut down the running instance and create a new tempora
    If you are using Docker, make sure to stop the temporary container and to restart the original one after the setup is complete
 
 
+**********************************
+Reverse Proxy
+**********************************
+
+It is highly recommended to run Gokapi behind a reverse proxy. Make sure to select a high timeout (recommended: 300 seconds) and increase the allowed body size.
+
+An example for Nginx can be found here: :ref:`nginx_config`
+
+
 **********************************
 Installing a systemd service
 **********************************

diff --git a/internal/configuration/setup/templates/setup.tmpl b/internal/configuration/setup/templates/setup.tmpl
@@ -239,7 +239,7 @@
 
 							<optgroup label="Reverse Proxy">
 								<option value="2">Header Authentication</option>
-								<option value="3">Access Restriction</option>
+								<option value="3">Disabled / Access Restriction</option>
 							</optgroup>
 
 						</select>
@@ -378,7 +378,7 @@
 
 						<ul>
 {{ range .ProtectedUrls }}
-						  <li>{{ . }}</li>
+						  <li><code>{{ . }}</code></li>
 {{ end }}
 						</ul>