diff --git a/filed/README.md b/filed/README.md index 23a3755..f3c7177 100644 --- a/filed/README.md +++ b/filed/README.md @@ -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: diff --git a/filed/create-files.sh b/filed/create-files.sh new file mode 100755 index 0000000..9b47d09 --- /dev/null +++ b/filed/create-files.sh @@ -0,0 +1,5 @@ +#!/bin/sh +# This script will create the .env and config files + +cp .env.example .env +cp config/filed.toml{,.example} \ No newline at end of file