mirror/Gokapi
1
0
Fork 0
mirror of https://github.com/Forceu/Gokapi.git synced 2026-02-16 05:28:40 -06:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs

Browse Source
This commit is contained in:
Marc Ole Bulling
2021-12-02 16:20:59 +01:00
parent 724489d2a4
commit 4b411f113f
1 changed files with 45 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
docs/advanced.rst
View File

@@ -60,43 +60,44 @@ General
--------
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| Name | Action | Persistent* | Default | Required for unattended setup |
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_CONFIG_DIR | Sets the directory for the config file | No | config | No |
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_CONFIG_FILE | Sets the name of the config file | No | config.json | No |
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_DATA_DIR | Sets the directory for the data | Yes | data | No |
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_USERNAME | Sets the admin username | Yes | unset | Yes |
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_PASSWORD | Sets the admin password | Yes | unset | Yes |
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_PORT | Sets the server port | Yes | 53842 | Yes |
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_EXTERNAL_URL | Sets the external URL where Gokapi can be reached | Yes | unset | Yes |
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_REDIRECT_URL | Sets the external URL where Gokapi will redirect to the index page is accesses | Yes | unset | Yes |
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_LOCALHOST | Bind server to localhost. Expects true/false/yes/no, always false for Docker images | Yes | false for Docker, otherwise unset | Yes |
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_SALT_FILES | Sets the salt for the file password hashes | Yes | random salt | Yes |
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_USE_SSL | Serve all content through HTTPS and generate certificates. Expects true/false/yes/no | Yes | unset | Yes |
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_SALT_ADMIN | Sets the salt for the admin password hash | Yes | random salt | No |
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_SALT_FILES | Sets the salt for the file password hashes | Yes | random salt | No |
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_LENGTH_ID | Sets the length of the download IDs. Value needs to be 5 or more | Yes | 15 | No |
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_MAX_FILESIZE | Sets the maximum allowed file size in MB | Yes | 102400 (100GB) | No |
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_DISABLE_LOGIN | Disables login for admin menu. DO NOT USE unless you have a 3rd party authentication for the /admin URL! | Yes | false | No |
+----------------------+----------------------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| Name | Action | Persistent* | Default | Required for unattended setup |
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_CONFIG_DIR | Sets the directory for the config file | No | config | No |
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_CONFIG_FILE | Sets the name of the config file | No | config.json | No |
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_DATA_DIR | Sets the directory for the data | Yes | data | No |
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_USERNAME | Sets the admin username | Yes | unset | Yes |
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_PASSWORD | Sets the admin password | Yes | unset | Yes |
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_PORT | Sets the server port | Yes | 53842 | Yes |
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_EXTERNAL_URL | Sets the external URL where Gokapi can be reached | Yes | unset | Yes |
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_REDIRECT_URL | Sets the external URL where Gokapi will redirect to the index page is accesses | Yes | unset | Yes |
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_LOCALHOST | Bind server to localhost. Expects true/false/yes/no, always false for Docker images | Yes | false for Docker, otherwise unset | Yes |
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_SALT_FILES | Sets the salt for the file password hashes | Yes | random salt | Yes |
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_USE_SSL | Serve all content through HTTPS and generate certificates. Expects true/false/yes/no | Yes | unset | Yes |
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_SALT_ADMIN | Sets the salt for the admin password hash | Yes | random salt | No |
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_SALT_FILES | Sets the salt for the file password hashes | Yes | random salt | No |
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_LENGTH_ID | Sets the length of the download IDs. Value needs to be 5 or more | Yes | 15 | No |
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_MAX_FILESIZE | Sets the maximum allowed file size in MB | Yes | 102400 (100GB) | No |
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
| GOKAPI_DISABLE_LOGIN | Disables login for admin menu. DO NOT USE unless you have a 3rd party authentication! ** | Yes | false | No |
+----------------------+------------------------------------------------------------------------------------------+-------------+-----------------------------------+-------------------------------+
\*Variables that are persistent must be submitted during the first start when Gokapi creates a new config file. They can be omitted afterwards. Non-persistent variables need to be set on every start.
\* Variables that are persistent must be submitted during the first start when Gokapi creates a new config file. They can be omitted afterwards. Non-persistent variables need to be set on every start.
\*\* Refer to :ref:`extauth`
Cloudstorage
-------------
@@ -117,6 +118,7 @@ All values that are described in :ref:`cloudstorage` can be passed as environmen
| GOKAPI_AWS_ENDPOINT | Sets the endpoint |
+-----------------------+-------------------------+
.. _extauth:
********************************
External Authentication
@@ -124,7 +126,13 @@ External Authentication
In order to use external authentication (eg. services like Authelia or Authentik), set the environment variable ``GOKAPI_DISABLE_LOGIN`` to ``true`` on the first start. *Warning:* This will diasable authentication for the admin menu, which can be dangerous if not set up correctly!
Refer to the documention of your reverse proxy on how to protect the ``/admin`` URL, as authentication is only required for this URL.
Refer to the documention of your reverse proxy on how to protect the following URLs:
* ``/admin``
* ``/apiNew``
* ``/apiDelete``
* ``/delete``
* ``/upload``
* ``/api`` (``/api/`` however does not need to be protected)
.. _api: