📝 add documentation
This commit is contained in:
parent
fa78fbff0f
commit
5be8a35856
2 changed files with 20 additions and 0 deletions
13
docs/config folder.md
Normal file
13
docs/config folder.md
Normal file
|
@ -0,0 +1,13 @@
|
||||||
|
# Config Folder
|
||||||
|
|
||||||
|
Everything should be configured through the mounted config folder.
|
||||||
|
To enable certain features just put the right files in there.
|
||||||
|
|
||||||
|
## General Config
|
||||||
|
The main configuration is in `config.json`. See [this](./config.json.md)
|
||||||
|
|
||||||
|
## Profile Picture
|
||||||
|
If you want to show a picture on the main page, place a file called `me.avif` in the config folder.
|
||||||
|
|
||||||
|
## PGP Key
|
||||||
|
If you want to share your public key, put it inside `pub.key`.
|
7
docs/config.json.md
Normal file
7
docs/config.json.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
# config.json
|
||||||
|
|
||||||
|
## Possible Values to configure:
|
||||||
|
- `name` : Personal Name
|
||||||
|
- `email` : Personal Mail
|
||||||
|
- `secret_key` : Secret Key for Flask
|
||||||
|
- `xmr_address` : Monero Receive Address
|
Loading…
Add table
Reference in a new issue