Changed "bare metal" to "native installation" in documentation #208, changed order

This commit is contained in:
Marc Ole Bulling
2024-11-28 06:25:18 +01:00
parent 6143449b8c
commit 5a155f7180
3 changed files with 35 additions and 32 deletions

View File

@@ -28,8 +28,8 @@ Pass the variable with the ``-e`` argument. Example for setting the port in use
docker run -it -e GOKAPI_PORT=12345 -e GOKAPI_DB_NAME=database.sqlite f0rc3/gokapi:latest
Bare Metal
----------
Native Deployment
-------------------
Linux / Unix
"""""""""""""

View File

@@ -4,35 +4,15 @@
Setup
=====
There are two different ways to setup Gokapi: Either a bare metal approach or docker.
There are two different ways to set up Gokapi: either a native deployment approach or a containerised installation using Docker/Podman.
Also there are two different versions: *Stable* indicates that you are using the latest release which should work without any bugs. *Unstable* is the latest developer version, which might include more features, but could also contain bugs.
Also, there are two different versions: *Stable* indicates that you are using the latest release, which should work without any major bugs. *Unstable* is the latest developer version, which might include more features but could also contain bugs.
**************
Installation
**************
Bare Metal
^^^^^^^^^^^^
Stable version
"""""""""""""""""
`Download the latest release <https://github.com/Forceu/gokapi/releases/latest>`_ and copy the executable into a new folder with write permissions. Select the executable according to your system. If you are using Windows, select ``gokapi-windows_amd64``, for Mac either ``gokapi-darwin_amd64`` or ``gokapi-darwin_arm64`` and for Linux the ``gokapi-linux_`` file matching your system.
Unstable version
"""""""""""""""""
Only recommended if you have experience with the command line. Go 1.20+ needs to be installed.
Create a new folder and in this folder execute
::
git clone https://github.com/Forceu/Gokapi.git .
go generate ./...
go build Gokapi/cmd/gokapi
This will compile the source code and create an executable from the latest code.
Docker
^^^^^^^
@@ -48,6 +28,28 @@ If you don't want to download the prebuilt image, you can find the Dockerfile on
Native Deployment
^^^^^^^^^^^^^^^^^^
Stable version
"""""""""""""""""
`Download the latest release <https://github.com/Forceu/gokapi/releases/latest>`_ and copy the executable into a new folder with write permissions. Select the executable according to your system. If you are using Windows, select ``gokapi-windows_amd64``, for Mac either ``gokapi-darwin_amd64`` or ``gokapi-darwin_arm64`` and for Linux the ``gokapi-linux_`` file matching your system.
Unstable version
"""""""""""""""""
Only recommended if you have experience with the command line. Go 1.20+ needs to be installed.
Create a new folder and in this folder execute
::
git clone https://github.com/Forceu/Gokapi.git .
make
This will compile the source code and create an executable from the latest code.
**************
First Start
**************
@@ -58,11 +60,6 @@ After the first start you will be redirected to a setup webpage. If you require
Starting Gokapi
^^^^^^^^^^^^^^^^
Bare Metal
""""""""""
To start Gokapi, execute the binary with your command line or by double clicking.
Docker
""""""""""
@@ -78,6 +75,12 @@ Set ``-e TZ=UTC`` to the timezone you are in, e.g. ``-e TZ=Europe/Berlin``.
If you do not want the binary to run as the root user in the container, you can set the environment variable ``DOCKER_NONROOT`` to true.
Native Deployment
""""""""""""""""""
To start Gokapi, execute the binary with your command line or by double clicking.
Initial Setup
^^^^^^^^^^^^^^^

View File

@@ -15,9 +15,9 @@ To update, run the following command:
Then stop the running container and follow the same steps as in SETUP. All userdata will be preserved, as it is saved to the ``gokapi-data`` and ``gokapi-data`` volume (``-v`` argument during creation)
**********
Bare Metal
**********
*******************
Native deployment
*******************
Stable version
==============