bfile/filed
b1ek c534a28ad7
filed: explain about .env and config/filed.toml for filed
2024-03-09 19:55:02 +10:00
..
config curl API help 2023-12-14 21:04:15 +10:00
docs properly implement delete method according to config 2023-12-14 21:04:26 +10:00
src fix compile warnings 2023-12-14 21:04:26 +10:00
static improve dragndrop zone size handling on mobile 2023-12-14 21:04:22 +10:00
templates add animation to the header 2023-12-14 21:04:23 +10:00
.dockerignore add dockerignore 2023-09-30 14:59:12 +10:00
.env.example add trust proxy env config 2023-10-23 20:54:15 +10:00
.gitignore gitignore .env in filed 2023-10-01 09:55:58 +10:00
Cargo.lock bump Cargo.toml version 2023-12-14 21:04:14 +10:00
Cargo.toml bump Cargo.toml version 2023-12-14 21:04:14 +10:00
Dockerfile.prod fix filed prod build errors 2023-12-18 00:59:14 +10:00
README.md filed: explain about .env and config/filed.toml for filed 2024-03-09 19:55:02 +10:00
build.rs minify templates on compile time 2023-12-14 21:04:16 +10:00
create-files.sh filed: explain about .env and config/filed.toml for filed 2024-03-09 19:55:02 +10:00
dev-entry.sh fix a few problems with template sources 2023-12-14 21:04:17 +10:00

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.