File Synchronization

Getting started with Fulgurant

Fulgurant is the self-hosted synchronization backend for Fulgur. Follow these steps to set up your own server and start syncing files across all your devices.

1

Step 1

Setup Fulgurant locally

Fulgurant is a lightweight, self-hosted server that acts as the relay for file synchronization between your Fulgur instances. The easiest way to run it is with Docker Compose.

Get docker-compose.yml

The default values are enough to get started with only 1 user. The only required value is JWT_SECRET which you can generate with openssl rand -base64 32.
Setting the e-mail settings is recommended to allow password reset or additional users registration.

Start the server

$ docker compose up -d
2

Step 2

Connect to the server

Once the container is running, open your browser and navigate to the Fulgurant web interface. On first launch, you will be prompted to set up your admin credentials.

Web interface

http://server_name_or_ip:3000

Set a strong password on first login.

3

Step 3

Create your device API keys

Each device that connects to your Fulgurant server needs its own API key. Create a new device and generate a new key for each. An expiration date can be set for each key.

Example API key

fulgur_k1Az•••••••••••••••••••••

Copy and save your API key immediately — it will not be shown again.

4

Step 4

Connect Fulgur to the server

Open Fulgur on the device you want to connect. Go to Settings and find the Fulgurant section. Enter your server URL and paste the API key you generated for that device.

Server URL

http:// server_name_or_ip:3000

API Key

fulgur_k1Az•••••••••••••••••••••

Connected to Fulgurant server

5

Step 5

Share files

You are all set. Open any file in Fulgur and use the Share button to send it to your other connected devices. Files are transferred instantly with end-to-end encryption.

E2E

Encrypted

P2P

Relayed

A device must have been connected at least once to Fulgurant in order to receive files.

Fulgurant is only needed for file synchronization. All other Fulgur features work standalone, offline.

Fulgurant is open source and self-hostable. Pull the Docker image, inspect the source, or contribute on GitHub.