History

blek f7e83a7c9b fix dumb directory name mistake		2023-10-21 00:40:11 +10:00
..
docs	minor api docs improvements	2023-10-08 15:15:41 +10:00
src	trade up unnecessary security for speed	2023-10-15 17:38:20 +10:00
static	minify css on build	2023-10-14 00:10:47 +10:00
templates	add error page	2023-10-13 23:37:03 +10:00
.dockerignore	add dockerignore	2023-09-30 14:59:12 +10:00
.env.example	add uploads path env variable	2023-10-07 19:29:11 +10:00
.gitignore	gitignore .env in filed	2023-10-01 09:55:58 +10:00
Cargo.lock	check the password on when the file is downloaded	2023-10-15 17:16:08 +10:00
Cargo.toml	check the password on when the file is downloaded	2023-10-15 17:16:08 +10:00
Dockerfile.prod	optimize the production dockerfile to produce a 2.5MB image	2023-10-09 23:54:14 +10:00
README.md	add note about build dependencies	2023-10-09 20:55:26 +10:00
build.rs	minify js	2023-10-14 13:19:09 +10:00
dev-entry.sh	fix dumb directory name mistake	2023-10-21 00:40:11 +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.

Building

First, install the build dependencies:

Rust toolchain
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.