diff --git a/docs/advanced.rst b/docs/advanced.rst index 7aefa55..681204f 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -99,6 +99,7 @@ All values that are described in :ref:`cloudstorage` can be passed as environmen +-----------------------+-------------------------+ +.. _api: ******************************** @@ -139,7 +140,7 @@ Customising By default, all files are included in the executable. If you want to change the layout (e.g. add your company logo or change the app name etc.), follow these steps: -1. Clone this repository +1. Download the source code for the Gokapi version you are using. It is either attached to the specific release `on Github `_ or you can clone the repository and checkout the tag for the specific version. 2. Copy either the folder ``static``, ``templates`` or both from the ``internal/webserver/web`` folder to the directory where the executable is located 3. Make changes to the folders. ``static`` contains images, CSS files and JavaScript. ``templates`` contains the HTML code. 4. Restart the server. If the folders exist, the server will use the local files instead of the embedded files diff --git a/docs/changelog.rst b/docs/changelog.rst index 6ae92ab..3b3abf8 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -75,6 +75,14 @@ v1.0: 12 Mar 2021 Upgrading ----------------------- +Upgrading to 1.5 +^^^^^^^^^^^^^^^^^^ + +* You need to update to Gokapi 1.3 before updating to Gokapi 1.5 +* After the upgrade the config file can be read-only +* Initial setup has to be done through a web interface now, setting Gokapi up through env variables is not possible anymore +* If you would like to use new features like a different authentication method, please run Gokapi with the paramter ``--reconfigure`` to open the setup + Upgrading to 1.3 ^^^^^^^^^^^^^^^^^^