ChaoticByte/drinks-manager
1
1
Fork 0
Code Issues Pull requests Projects Releases 20 Packages Wiki Activity Actions

Updated docs

Browse source
This commit is contained in:
W13R 2022-05-29 20:56:16 +02:00
parent 97462c7884
commit df91a89cd5
3 changed files with 23 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -1,6 +1,6 @@
# Drinks Manager (season 2) # Drinks Manager (season 2)
Note: This piece of software is tailored to my own needs. Note: This software is tailored to my own needs.
I probably won't accept feature requests, and don't recommend you I probably won't accept feature requests, and don't recommend you
to use this software if this isn't exactly what you are looking for. to use this software if this isn't exactly what you are looking for.
@ -15,7 +15,7 @@ You have to bring your own PostgreSQL Database though.
## Setup, Installation, Updating and Dependencies ## Setup, Installation, Updating and Dependencies
You can find the latest releases [here](https://gitlab.com/W13R/drinks-manager/-/releases), but for Installation/Updating, you should consider using Git. You can find the latest releases [here](https://gitlab.com/W13R/drinks-manager/-/releases), but you should consider using Git to easily switch between versions.
For more information see [Setup](docs/Setup.md). For more information see [Setup](docs/Setup.md).

8
docs/Configuration.md
View file

@ -2,13 +2,13 @@
## Main Configuration ## Main Configuration
`./config/config.sh` <u>`config/config.sh`</u>
There is no default configuration available, only a sample configuration with explanations. There is a sample configuration with explanations: [/config/config.sample.sh](/config/config.sample.sh)
## Caddy Server Configuration ## Caddy (Reverse Proxy & Static File Server)
`./config/Caddyfile` <u>[config/Caddyfile](/config/Caddyfile)</u>
The default configuration should work out of the box, don't edit this file unless you know what you're doing. The default configuration should work out of the box, don't edit this file unless you know what you're doing.

28
docs/Setup.md
View file

@ -20,7 +20,7 @@ Before the actual setup, you have to satisfy the following dependencies:
### Python Packages (pip) ### Python Packages (pip)
All required python packages are listed `in pip-dependencies.txt` All required python packages are listed in [pip-dependencies.txt](/pip-dependencies.txt)
You can install the required python packages with You can install the required python packages with
```bash ```bash
@ -32,9 +32,9 @@ You can install the required python packages with
You can get the latest version with git: You can get the latest version with git:
``` ```
git clone --branch release-x.x https://gitlab.com/W13R/drinks-manager.git git clone --branch release-x https://gitlab.com/W13R/drinks-manager.git
``` ```
(replace x.x with the latest version) (replace x with the latest version)
Alternatively, you can download the [latest release](https://gitlab.com/W13R/drinks-manager/-/releases) and extract the files to your prefered destination. Alternatively, you can download the [latest release](https://gitlab.com/W13R/drinks-manager/-/releases) and extract the files to your prefered destination.
@ -55,9 +55,9 @@ If you installed the application with git, you can run the following in the drin
``` ```
git fetch git fetch
git checkout x.x git checkout x
``` ```
(replace x.x with the new version) (replace x with the new version)
If you downloaded the application from the releases page, you can download the new release in the same manner, and overwrite the old files with the new ones. If you downloaded the application from the releases page, you can download the new release in the same manner, and overwrite the old files with the new ones.
@ -69,16 +69,20 @@ Further upgrading-instructions may be provided in the Release Notes on the Relea
## III. Database ## III. Database
This project is using PostgreSQL. You have to set up a database by yourself. This project is using PostgreSQL. You have to set up a database:
The database must have the schema `public` (exists on a new database). Make shure that you create a database user with the necessary privileges to write to and read from the database (SELECT, INSERT, UPDATE, DELETE, TRUNCATE, REFERENCES, CREATE, CONNECT):
```sql ```sql
-- connected to target database create user drinksmanager password '<a safe password>';
grant SELECT, INSERT, UPDATE, DELETE, TRUNCATE, REFERENCES on all tables in schema public to <dbuser>; create database drinksmgr owner drinksmanager;
grant CREATE, CONNECT on database <dbname> to <dbuser>;
``` ```
You can configure your database connection in `config/config.sh`. After creating the user, you have to edit your `pg_hba.conf` (see https://www.postgresql.org/docs/current/auth-pg-hba-conf.html).
Add the following line:
```
host drinksmgr drinksmanager 127.0.0.1/32 md5
```
Now you can configure your database connection in `config/config.sh`.
## IV. HTTPS & TLS Certificates ## IV. HTTPS & TLS Certificates
@ -89,7 +93,7 @@ Filepaths:
- `config/tls/server.pem` for the certificate - `config/tls/server.pem` for the certificate
- `config/tls/server-key.pem` for the key - `config/tls/server-key.pem` for the key
You can set another filepath for those files in your caddy configuration at `config/Caddyfile`. You can set another filepath for those files in your caddy configuration at [config/Caddyfile](/config/Caddyfile).
## V. Configuration ## V. Configuration