mirror/Gokapi
1
0
Fork 0
mirror of https://github.com/Forceu/Gokapi.git synced 2025-12-30 13:29:34 -06:00
Code Issues Packages Projects Releases Wiki Activity

Changed /api endpoint to /apiKeys in order to avoid confusion with /api/

Browse Source
This commit is contained in:
Marc Ole Bulling
2021-12-02 16:30:57 +01:00
parent 4b411f113f
commit 0bd9bd1a8d
4 changed files with 16 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/advanced.rst
View File

@@ -124,15 +124,16 @@ All values that are described in :ref:`cloudstorage` can be passed as environmen
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!
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 following URLs:**
Refer to the documention of your reverse proxy on how to protect the following URLs:
* ``/admin``
* ``/apiNew``
* ``/apiDelete``
* ``/apiKeys``
* ``/apiNew``
* ``/delete``
* ``/upload``
* ``/api`` (``/api/`` however does not need to be protected)
.. _api:
@@ -140,7 +141,7 @@ Refer to the documention of your reverse proxy on how to protect the following U
API
********************************
Gokapi offers an API that can be reached at ``http(s)://your.gokapi.url/api``. You can find the current documentation with an overview of all API functions and examples at ``http(s)://your.gokapi.url/apidocumentation/``.
Gokapi offers an API that can be reached at ``http(s)://your.gokapi.url/api/``. You can find the current documentation with an overview of all API functions and examples at ``http(s)://your.gokapi.url/apidocumentation/``.
Interacting with the API