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

Better documentation for customising #41, added upgrade instructions for v1.5, fixed API link

Browse Source
This commit is contained in:
Marc Ole Bulling
2022-01-24 14:37:08 +01:00
parent 9f41697eb2
commit 28f9aff798
2 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/advanced.rst
View File

@@ -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 <https://github.com/Forceu/Gokapi/releases>`_ 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

8
docs/changelog.rst
View File

@@ -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
^^^^^^^^^^^^^^^^^^