Filyo — Private & Local File Transfer / Transfert de fichiers local & privé

Warning

🇬🇧 Pre-release software — This project is currently in pre-release. The database schema may change between versions without a migration path. If you encounter database errors or startup failures after updating, a clean reinstall is required: stop the containers, delete the data volume, and restart.

🇫🇷 Logiciel en pré-version — Ce projet est actuellement en pré-release. Le schéma de base de données peut changer entre les versions sans chemin de migration. Si vous rencontrez des erreurs de base de données ou des échecs au démarrage après une mise à jour, une réinstallation propre est nécessaire : arrêtez les conteneurs, supprimez le volume de données et redémarrez.

Why Filyo? I created this application because I couldn't find a simple file-sharing tool that suited my needs. So, I decided to build my own, with the help of AI.

Self-hosted file-sharing app, no S3 storage. Dark glassmorphism design, bilingual interface (FR/EN), and reverse sharing feature.

📸 Screenshots

Upload page	Dashboard

Reverse sharing	User profile

✨ Features

Feature	Description
File upload	Multi-file upload with progress bar and drag & drop
Resumable upload	TUS protocol — interrupted uploads resume automatically
Proxy-safe upload mode	Splits files into chunks to work around per-request size limits from proxies and CDNs (Cloudflare, Nginx, Vercel…); configurable from admin settings
Protection	Optional password per file/link
Rate limiting	Brute-force protection on login, password reset and file deposit
Expiration	1h / 24h / 7d / 30d / never
Max downloads	Configurable limit per link
Email sharing	Send share link by email
Reverse sharing	Create a link to receive files from others
Reverse share email	Send deposit link by email to one or more recipients
Sender info	Name, email, message attached to deposit
Dashboard	Stats, sent & received files, deposit requests
Multi-user	Admin/User roles, admin panel management
Open registration	Optionally enable public signup from settings
Profile	Avatar, display name, password change
Settings	App name, logo, SMTP, registration, appearance
Themes	Dark/Light/Auto + customizable accent colors
i18n	Fully translated in French and English
Docker	Multi-arch images (amd64 + arm64), SQLite and MariaDB variants
Per-user storage quota	Admin can set a storage limit per user (MB/GB); enforced on upload to prevent disk saturation
Encrypted SMTP password	SMTP password stored encrypted in the database (AES-256-GCM, key derived from `JWT_SECRET`)

🚀 Quick Start

SQLite (recommended)

cp .env.example .env
docker compose up -d

MariaDB (prod/multi-user)

cp .env.example .env
docker compose -f docker-compose-mariadb.yml up -d

http://localhost:3001 → Create your admin account on first launch.

📖 Full documentation

→ AIDE.md — Complete guide (EN + FR) covering all features, limits, TUS protocol, cleanup, quotas, security…

🌐 Reverse proxy (Traefik/Nginx)

Relative API paths → zero config needed !

Traefik :

labels:
  - "traefik.enable=true"
  - "traefik.http.routers.filyo.rule=Host(`filyo.yourdomain.com`)"
  - "traefik.http.services.filyo.loadbalancer.server.port=3001"

🔧 Environment variables

Variable	Default	Description
`JWT_SECRET`	required, no default	Required — must be set before first launch. Also used as the AES-256-GCM encryption key for the SMTP password stored in the database.
`PORT`	`3001`	Host port exposed by the container (internal port is always 3001)
`DATA_PATH`	`./data`	Data folder (database + uploads)
`LOG_LEVEL`	`info`	Minimum log level (Pino). The app emits `debug`, `info`, `warn`, `error`. Use `debug` for verbose output, `warn` for quiet, `silent` to disable all logs.
`UPLOAD_TIMEOUT_MS`	`1800000`	Upload timeout in ms (default 30 min, min 1 min, max 2 h)
`TRUST_PROXY`	`false`	Trust level for reverse proxy headers (`X-Forwarded-*`). Accepts `false`, `true`, an IP address, or a CIDR range (e.g. `127.0.0.1`). Enable only if Filyo is behind a trusted proxy.
`TUS_CHUNK_MB`	`90`	Chunk size in MB used when the proxy-safe upload mode is enabled (admin toggle in Settings). Lower this value if your proxy or CDN rejects large chunks. Common limits: Cloudflare 100 MB (Free/Pro), Nginx default 1 MB (`client_max_body_size`), Vercel 4.5 MB. Has no effect when the mode is disabled.
`TUS_EXPIRY`	`1h`	How long an interrupted TUS upload can be resumed after it stalls. Accepts `30m` or `2h` format. Once expired, the server rejects any resume attempt; the partial file is then physically deleted on the next `CLEANUP_INTERVAL` run. Default: 1 h.
`CLEANUP_INTERVAL`	`1h`	Interval between scheduled cleanup runs (expired files + incomplete TUS uploads). Accepts `30m` or `2h` format. Default: 1 h.
`REGISTER_DEFAULT_QUOTA`	`500MB`	Default storage quota assigned to users who self-register (open registration). Accepts `500MB` or `2GB` format. Set to `0` or leave empty to assign no quota by default. Has no effect on accounts created by an admin (quota set manually).

Note

Any SMTP password saved through the settings form is stored encrypted in the database (AES-256-GCM, key derived from JWT_SECRET). Rotating JWT_SECRET breaks existing encrypted passwords — you must re-enter the SMTP password in the settings after any key rotation.

SQLite : DATABASE_URL=file:/data/filyo.db MariaDB : DB_HOST, DB_USER, DB_PASSWORD, etc.

🛡️ Note on `TRUST_PROXY`

If you run Filyo behind a reverse proxy (Traefik, Nginx, etc.), set TRUST_PROXY in your environment or .env so the Fastify server trusts X-Forwarded-* headers and correctly obtains the client IP, protocol and origin. The provided Docker files default to TRUST_PROXY=false.

Warning

Only enable TRUST_PROXY if Filyo is exclusively accessible through a trusted proxy and not directly exposed to the internet. Without this precaution, malicious clients can forge X-Forwarded-* headers to bypass rate limiting or IP-based controls.

Value	Behaviour
`false`	Default — no proxy trust
`true`	Trust all proxies (convenient but less secure)
`127.0.0.1`	Trust only localhost proxy (recommended)
`10.0.0.0/8`	Trust a specific IP range / CIDR

Note

For the TUS upload server, @tus/server only accepts a boolean for respectForwardedHeaders. Any IP or CIDR value will therefore behave like true (all forwarded headers trusted). Fastify itself still validates the IP/CIDR correctly for the rest of the API.

🍪 Authentication cookie

Filyo stores the JWT in an HttpOnly cookie (named token) so it is never accessible from JavaScript, which prevents XSS-based token theft.

Context	`secure` flag	`sameSite` flag
Production (`NODE_ENV=production`)	`true` — HTTPS only	`Strict`
Development (`NODE_ENV=development`)	`false`	`Lax`

Development (Vite + backend on separate ports)

Vite (port 5173) proxies API calls to the backend (port 3001). The vite.config.ts proxy handles this automatically — cookies are sent because both are treated as same-origin.

// vite.config.ts — already configured
server: {
  proxy: {
    '/api': 'http://localhost:3001'
  }
}

Production (Docker)

In the default Docker image, frontend and backend share the same origin (port 3001), so cookies work out of the box without any additional configuration.

Warning

The cookie is automatically set to secure: true in production. Make sure Filyo is served over HTTPS in production, otherwise the browser will reject the cookie and users will not be able to log in.

🗄️ SQLite vs MariaDB

	SQLite	MariaDB
Setup	✅ Zero dependency	⚠️ Separate container
Use case	Personal/family	Multi-user/production
Docker image	`:latest`	`:latest-mariadb`
Backup	Copy `filyo.db`	`mysqldump`

📦 CI/CD GitHub Actions

Lint + type-check (push/PR)
Multi-arch build → ghcr.io/mouette03/filyo
Tags: latest, sha-xxxx, v1.0.3(-mariadb)

docker pull ghcr.io/mouette03/filyo:v1.0.3

📜 Licenses & Credits

Filyo License

Main dependencies

Project	License	Role
Backend
Fastify	MIT	API Framework
Prisma	Apache-2.0	Database
bcryptjs	MIT	Authentication
@tus/server	MIT	Resumable uploads
Frontend
React	MIT	UI
TailwindCSS	MIT	Design
Vite	MIT	Build tool
Zustand	MIT	State management

Full inventory:

Backend — API (100+ dependencies)
Frontend — UI (150+ dependencies)

100% MIT/Apache/ISC — permissive licenses, AGPL compatible.

🙏 Thanks to

Fastify Team — Blazing fast API ⚡
Prisma Team — Magic ORM ✨
tus Team — Resumable uploads protocol 🔄
React Team — Modern UI
Tailwind Labs — Glassmorphism design
100+ open-source maintainers !

licenses.csv auto-updated via GitHub Actions

Pourquoi Filyo ? J'ai créé cette application car je n'ai pas trouvé d'outil de partage de fichiers simple qui me convenait. J'ai donc décidé de la développer moi-même, avec l'aide de l'IA.

Application de partage de fichiers auto-hébergée, sans stockage S3. Design glassmorphism sombre, interface bilingue (FR/EN), et fonctionnalité de partage inversé.

📸 Captures d'écran

Page d'envoi	Tableau de bord

Partage inversé	Profil utilisateur

✨ Fonctionnalités

Fonctionnalité	Description
Envoi de fichiers	Upload multi-fichiers avec barre de progression et glisser-déposer
Upload repris automatiquement	Protocole TUS — les uploads interrompus reprennent automatiquement
Mode upload proxy-compatible	Découpe les fichiers en morceaux pour contourner les limites de taille des proxies et CDN (Cloudflare, Nginx, Vercel…) ; configurable dans les réglages admin
Protection	Mot de passe optionnel par fichier/lien
Limitation de débit	Protection brute-force sur login, reset mot de passe et dépôt de fichiers
Expiration	1h / 24h / 7j / 30j / jamais
Max téléchargements	Limite configurable par lien
Envoi par email	Envoi du lien de partage par email
Partage inversé	Créer un lien pour recevoir des fichiers d'un tiers
Email partage inversé	Envoi du lien de dépôt par email à un ou plusieurs destinataires
Info déposant	Nom, email, message joint au dépôt
Dashboard	Statistiques, fichiers envoyés & reçus, demandes de dépôt
Multi-utilisateurs	Rôles Admin/Utilisateur, gestion panneau admin
Inscription libre	Activation optionnelle depuis réglages
Profil	Avatar, nom, changement mot de passe
Réglages	Nom app, logo, SMTP, inscription, apparence
Thèmes	Sombre/Clair/Auto + couleurs personnalisables
i18n	Français + Anglais
Docker	Multi-arch (amd64/arm64), SQLite + MariaDB
Quota stockage par utilisateur	L'administrateur peut définir une limite de stockage par utilisateur (MB/GB) ; appliquée lors des uploads pour éviter la saturation du disque
Chiffrement mot de passe SMTP	Mot de passe SMTP chiffré en base (AES-256-GCM, clé dérivée de `JWT_SECRET`)

🚀 Lancement rapide

SQLite (recommandé)

cp .env.example .env
docker compose up -d

MariaDB (prod/multi-users)

cp .env.example .env
docker compose -f docker-compose-mariadb.yml up -d

http://localhost:3001 → Crée ton compte admin au 1er lancement.

🌐 Reverse proxy (Traefik/Nginx)

Chemins relatifs → zéro config !

Traefik :

labels:
  - "traefik.enable=true"
  - "traefik.http.routers.filyo.rule=Host(`filyo.mondomaine.fr`)"
  - "traefik.http.services.filyo.loadbalancer.server.port=3001"

🔧 Variables d'environnement

Variable	Défaut	Description
`JWT_SECRET`	obligatoire, aucun défaut	Obligatoire — à renseigner avant le premier lancement. Sert aussi de clé AES-256-GCM pour chiffrer le mot de passe SMTP stocké en base.
`PORT`	`3001`	Port exposé sur l'hôte (le conteneur interne tourne toujours sur 3001)
`DATA_PATH`	`./data`	Dossier données (base de données + uploads)
`LOG_LEVEL`	`info`	Seuil minimum de log (Pino). Le code émet `debug`, `info`, `warn`, `error`. Utiliser `debug` pour plus de verbosité, `warn` pour le silence relatif, `silent` pour tout désactiver.
`UPLOAD_TIMEOUT_MS`	`1800000`	Délai d'attente des uploads (ms — défaut 30 min, min 1 min, max 2 h)
`TRUST_PROXY`	`false`	Niveau de confiance pour les en-têtes reverse proxy (`X-Forwarded-*`). Accepte `false`, `true`, une adresse IP ou une plage CIDR (ex. `127.0.0.1`). À activer uniquement si Filyo est derrière un proxy de confiance.
`TUS_CHUNK_MB`	`90`	Taille en Mo de chaque morceau lors de l'upload en mode upload proxy-compatible (toggle admin dans Réglages). Réduisez cette valeur si votre proxy ou CDN rejette les gros morceaux. Limites courantes : Cloudflare 100 Mo (Free/Pro), Nginx 1 Mo par défaut (`client_max_body_size`), Vercel 4,5 Mo. Sans effet lorsque le mode est désactivé.
`TUS_EXPIRY`	`1h`	Durée pendant laquelle un upload TUS interrompu peut être repris. Accepte le format `30m` ou `2h`. Une fois expiré, le serveur refuse toute tentative de reprise ; le fichier partiel est ensuite supprimé physiquement au prochain passage de `CLEANUP_INTERVAL`. Défaut : 1 h.
`CLEANUP_INTERVAL`	`1h`	Intervalle entre chaque passage du job de nettoyage (fichiers expirés + uploads TUS incomplets). Accepte le format `30m` ou `2h`. Défaut : 1 h.
`REGISTER_DEFAULT_QUOTA`	`500MB`	Quota de stockage par défaut attribué aux utilisateurs qui s'auto-inscrivent (inscription libre). Accepte le format `500MB` ou `2GB`. Mettre `0` ou laisser vide pour n'attribuer aucun quota par défaut. Sans effet sur les comptes créés par un administrateur (quota défini manuellement).

Note

Tout mot de passe SMTP enregistré via le formulaire de réglages est stocké chiffré en base de données (AES-256-GCM, clé dérivée de JWT_SECRET). Une rotation de JWT_SECRET invalide les mots de passe chiffrés existants — vous devez ressaisir le mot de passe SMTP dans les réglages après tout changement de clé.

SQLite : DATABASE_URL=file:/data/filyo.db MariaDB : DB_HOST, DB_USER, DB_PASSWORD, etc.

🛡️ Note sur `TRUST_PROXY`

Si vous exécutez Filyo derrière un reverse proxy (Traefik, Nginx, etc.), définissez TRUST_PROXY dans votre environnement ou votre fichier .env afin que le serveur Fastify fasse confiance aux en-têtes X-Forwarded-* et récupère correctement l'adresse IP du client, le protocole et l'origine. Les fichiers Docker fournis définissent par défaut TRUST_PROXY=false.

Warning

N'activez TRUST_PROXY que si Filyo est exclusivement accessible via un proxy de confiance et non exposé directement sur Internet. Sans cette précaution, des clients malveillants peuvent forger les en-têtes X-Forwarded-* pour contourner le rate limiting ou les contrôles basés sur l'IP.

Valeur	Comportement
`false`	Défaut — aucune confiance proxy
`true`	Fait confiance à tous les proxies (pratique mais moins sécurisé)
`127.0.0.1`	Fait confiance uniquement au proxy local (recommandé)
`10.0.0.0/8`	Fait confiance à une plage IP / CIDR spécifique

Note

Pour le serveur TUS, @tus/server n'accepte qu'un booléen pour respectForwardedHeaders. Toute valeur IP ou CIDR sera donc traitée comme true (tous les headers forwarded sont acceptés). Fastify continue de valider l'IP/CIDR correctement pour le reste de l'API.

🍪 Cookie d'authentification

Filyo stocke le JWT dans un cookie HttpOnly (nommé token) afin qu'il ne soit jamais accessible depuis JavaScript, ce qui empêche le vol de token par XSS.

Contexte	Flag `secure`	Flag `sameSite`
Production (`NODE_ENV=production`)	`true` — HTTPS uniquement	`Strict`
Développement (`NODE_ENV=development`)	`false`	`Lax`

Développement (Vite + backend sur des ports séparés)

Vite (port 5173) proxifie les appels API vers le backend (port 3001). Le proxy vite.config.ts gère cela automatiquement — les cookies sont envoyés car les deux sont traités comme étant de la même origine.

// vite.config.ts — déjà configuré
server: {
  proxy: {
    '/api': 'http://localhost:3001'
  }
}

Production (Docker)

Dans l'image Docker par défaut, le frontend et le backend partagent la même origine (port 3001), donc les cookies fonctionnent sans configuration supplémentaire.

Warning

Le cookie est automatiquement défini avec secure: true en production. Assurez-vous que Filyo est servi en HTTPS en production, sinon le navigateur rejettera le cookie et les utilisateurs ne pourront pas se connecter.

🗄️ SQLite vs MariaDB

	SQLite	MariaDB
Setup	✅ Zéro dépendance	⚠️ Conteneur DB
Usage	Personnel/familial	Prod/multi-users
Image	`:latest`	`:latest-mariadb`
Backup	Copier `filyo.db`	`mysqldump`

📦 CI/CD GitHub Actions

Lint + type-check (push/PR)
Build multi-arch → ghcr.io/mouette03/filyo
Tags : latest, sha-xxxx, v1.0.3(-mariadb)

docker pull ghcr.io/mouette03/filyo:v1.0.3

📜 Licences & Remerciements

Licence Filyo

Dépendances principales

Projet	Licence	Rôle
Backend
Fastify	MIT	API Framework
Prisma	Apache-2.0	Base de données
bcryptjs	MIT	Authentification
@tus/server	MIT	Uploads repris
Frontend
React	MIT	Interface
TailwindCSS	MIT	Design
Vite	MIT	Build tool
Zustand	MIT	State

Inventaire complet :

Backend — API (100+ dépendances)
Frontend — UI (150+ dépendances)

100% MIT/Apache/ISC — licences permissives et compatibles AGPL.

🙏 Remerciements

Fastify Team — API ultra-performante ⚡
Prisma Team — ORM magique ✨
tus Team — Protocole d'upload repris 🔄
React Team — Interface moderne
Tailwind Labs — Design glassmorphism
100+ mainteneurs open source !

licenses.csv auto-mis à jour via GitHub Actions

Name		Name	Last commit message	Last commit date
Latest commit History 137 Commits
.github/workflows		.github/workflows
backend		backend
docs/screenshots		docs/screenshots
frontend		frontend
.coderabbit.yaml		.coderabbit.yaml
.dockerignore		.dockerignore
.env.example		.env.example
.gitignore		.gitignore
AIDE.md		AIDE.md
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
docker-compose-mariadb.yml		docker-compose-mariadb.yml
docker-compose.yml		docker-compose.yml
entrypoint.sh		entrypoint.sh
filyo.svg		filyo.svg

Folders and files

Latest commit

History

Repository files navigation

Filyo — Private & Local File Transfer / Transfert de fichiers local & privé

📸 Screenshots

✨ Features

🚀 Quick Start

SQLite (recommended)

MariaDB (prod/multi-user)

📖 Full documentation

🌐 Reverse proxy (Traefik/Nginx)

🔧 Environment variables

🛡️ Note on TRUST_PROXY

🍪 Authentication cookie

Development (Vite + backend on separate ports)

Production (Docker)

🗄️ SQLite vs MariaDB

📦 CI/CD GitHub Actions

📜 Licenses & Credits

Filyo License

Main dependencies

🙏 Thanks to

📸 Captures d'écran

✨ Fonctionnalités

🚀 Lancement rapide

SQLite (recommandé)

MariaDB (prod/multi-users)

🌐 Reverse proxy (Traefik/Nginx)

🔧 Variables d'environnement

🛡️ Note sur TRUST_PROXY

🍪 Cookie d'authentification

Développement (Vite + backend sur des ports séparés)

Production (Docker)

🗄️ SQLite vs MariaDB

📦 CI/CD GitHub Actions

📜 Licences & Remerciements

Licence Filyo

Dépendances principales

🙏 Remerciements

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

🛡️ Note on `TRUST_PROXY`

🛡️ Note sur `TRUST_PROXY`

Packages