filed: explain about .env and config/filed.toml for filed

This commit is contained in:
b1ek 2024-03-09 19:55:02 +10:00
parent 830677cc0e
commit c534a28ad7
Signed by: blek
GPG Key ID: 14546221E3595D0C
2 changed files with 10 additions and 0 deletions

View File

@ -2,6 +2,11 @@
This is a part of blek! File that is responsible for serving and uploading files.
This module is released under the GPLv3 with additions, copy of which is included in the top level of this repository.
## Required files
You need to have `.env` and `config/filed.toml` files for it to run. They have templates that end with `.example` that you can copy and edit.
There is a script `create-files.sh` that can copy them for you. The example is sufficient by itself and if you dont care much of the customization, you can leave it as is.
## Building
First, install the build dependencies:

5
filed/create-files.sh Executable file
View File

@ -0,0 +1,5 @@
#!/bin/sh
# This script will create the .env and config files
cp .env.example .env
cp config/filed.toml{,.example}