22 lines
1.1 KiB
Markdown
22 lines
1.1 KiB
Markdown
# fileD - file daemon
|
|
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:
|
|
|
|
1. Rust toolchain
|
|
2. Git (latest version)
|
|
|
|
To get started with this, copy either `Dockerfile.dev` or `Dockerfile.prod` to `Dockerfile`, depending on your environment.
|
|
|
|
Then either build it manually or start it up using the `docker-compose.yml` file, which is provided in the top level directory.
|
|
|
|
## Deploying notes
|
|
Files will be saved in `/opt/user_uploads` (as defined in `.env`). Mount that directory into a volume or host directory to easily back up the data.
|