Filekatze

a frontend for EepyFileServer

Prerequisites

• EepyFileServer
• Python 3.10+ (3.12+ recommended)

Install

Clone this repository: git clone --recurse-submodules https://codeberg.org/mystie/filekatze.git

Note

You must clone the repository with the --recurse-submodules option

Go into the cloned repository, create a virtual environment and activate it:

Linux

python3 -m venv venv && . venv/bin/activate

Windows (PowerShell)

py -m venv venv; .\venv\Scripts\activate

---

After that, install required packages:

pip install -r requirements.txt

Then, rename .env.example to .env, and configure all the values below:

PASSWORD - password to access the backend
APP_SECRET - application secret, generate one with this command: python3 -c 'import secrets; print(secrets.token_hex())'

Usage

Starting Filekatze

Start Filekatze with this command:

gunicorn -w 4 app:app

Filekatze runs on 127.0.0.1:8000 by default, if you want Filekatze to be accessible on a specific host address, add a --bind option to the command (e.g. --bind 127.0.0.1:5000)
For debugging, run flask run --debug

Examples

Caddy

This repository contains an example Caddyfile that runs Filekatze on filekatze.localhost by reverse proxying it to :5000 (127.0.0.1:5000), you can modify it as needed

Contributing

You can contribute to this project by making a pull request:

1. Fork this repository (skip if you already did that)
2. Make your changes
3. Create a pull request here: https://codeberg.org/mystie/filekatze/compare

Be open for discussion about the feature you want to add