bfile/filed/README.md

# 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.
base code 2023-09-29 12:15:07 +02:00			`# fileD - file daemon`
license text 2023-09-29 12:34:36 +02:00			`This is a part of blek! File that is responsible for serving and uploading files.`
fix compile warnings 2023-09-29 12:36:02 +02:00			`This module is released under the GPLv3 with additions, copy of which is included in the top level of this repository.`
dockerify 2023-09-30 06:46:29 +02:00
filed: explain about .env and config/filed.toml for filed 2024-03-09 10:55:02 +01:00			`## 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.

dockerify 2023-09-30 06:46:29 +02:00			`## Building`
add note about build dependencies 2023-10-09 12:55:26 +02:00			`First, install the build dependencies:`

			`1. Rust toolchain`
			`2. Git (latest version)`

dockerify 2023-09-30 06:46:29 +02:00			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.
all the stuff for uploading the files 2023-10-01 06:17:58 +02:00
			`## Deploying notes`
update .env.example 2023-10-01 06:43:27 +02:00			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.