Fileship

Fileship

Edit on GitHub

First steps

You installed Fileship with Docker, without Docker or on Windows, and it opens at http://<server>:3000. These steps take a few minutes.

1. Secure the admin account

Log in with admin / password, then open Settings → Security:

  1. Under Password, set a new password with Change password.
  2. Optionally turn on the Authenticator app or add a Passkey. Passkeys only work over HTTPS (or on http://localhost).

The seed account is a Super admin: it can change instance settings, manage storage and other admins. To use another username, change it in Settings → Profile.

2. Put it on your domain

Set up a reverse proxy with HTTPS, then open Administration → Instance → General and set:

  • Dashboard address: the public address, for example https://files.example.com. Emails and single sign-on build their links from it.
  • Link protocol: leave it on Same as the request unless your links come out with the wrong protocol.

Site name is shown in the browser title, link previews and emails.

3. Review the instance settings

Still in Administration → Instance, go through the sections once. The defaults are fine for most servers; Instance settings explains each field.

  • AI: on by default with the medium preset (6 GB RAM). On a small server, choose Low (4 GB RAM) or turn AI features off. See AI features.
  • Uploads: chunk size, EXIF removal and how long deleted items stay in the trash.
  • Email: needed for password reset links, invites and storage warnings. See Email.
  • Storage: keep files on the server's disk (the default) or add S3, SFTP or FTP. See Storage.

4. Add people

Open Administration → Users:

  • New user creates an account with a username, a password, permissions and limits.
  • Invite sends an email with a link to sign up (needs email).

Or let people sign up themselves, or log in through your identity provider. See Registration and invites, Single sign-on and Users and permissions.

5. Connect your uploaders

Open Settings → Integrations. The Upload token there lets tools upload files and shorten links for you; set your Upload options and download a config:

6. Plan backups

Fileship's own account backups (Settings → Backups) are per user. To protect the whole server, back up the database and the data folder, including secret.key. See Backing up the database.