Install

SpiderFolio runs on your server with Docker. Your company can be up and running in an afternoon.

What you need

A Linux server with Docker and Docker Compose v2
2 vCPUs and 4 GB of RAM (up to ~200 people)
An SMTP email server (your company's or a transactional service)
A domain pointing to the server, to sign in over HTTPS from any device

1

Download

Clone the repository and copy the example configuration.

git clone https://github.com/spiderjad/SpiderFolio.git
cd SpiderFolio/deploy
cp .env.example .env

2

Configure

Fill in the URL, the database password, the secrets and your email server. Generate the secrets with openssl.

openssl rand -base64 48   # JWT_ACCESS_SECRET
openssl rand -base64 32   # EMAIL_ENCRYPTION_KEY and MFA_ENCRYPTION_KEY (a different one for each)

3
Start
One command starts the database, the app and the worker. Migrations run automatically. With a domain, the https profile requests the certificate automatically.
```
docker compose --profile https up -d
docker compose logs -f app
```
4
Create your company
Go to your domain, sign up and you become the owner. Then invite your team from Administration.
```
https://your-domain/register
```

Optional

Controlled PDF
Add the pdf profile (Gotenberg) to generate the PDF of controlled documents.
Files on S3
By default they go to the server's disk. You can also use S3, R2 or MinIO.
Bian, the AI assistant
Turn on Bian with your Anthropic API key.
Plugins
Commercial features enabled with a license, offline.

Maintenance

Update
docker compose pull && docker compose up -d, after taking a backup.
Backups
backup.sh saves the database, the files and the configuration; restore.sh brings them back.

Read the full guide