Skip to content

About

Self-hosted web file manager with fast indexed search, granular share controls, and modern authentication (OIDC, LDAP, 2FA).

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

FileBrowser Quantum

Build Status Last Commit OCI Pulls

Self-hosted web file manager with fast indexed search, granular share controls, and modern authentication (OIDC, LDAP, 2FA).

Port 8080
Registry ghcr.io/daemonless/filebrowser-quantum
Source https://github.com/gtsteffaniak/filebrowser
Website https://filebrowserquantum.com

Version Tags

Tag Description Best For
latest FreeBSD Port. Built from latest FreeBSD packages. Most users — recommended.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

services:
  filebrowser-quantum:
    image: "ghcr.io/daemonless/filebrowser-quantum:latest"
    container_name: filebrowser-quantum
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      # - FILEBROWSER_CONFIG=  # Path to config.yaml. Defaults to /config/config.yaml; the container writes a minimal starter there on first boot if absent.
    volumes:
      - "/containers/filebrowser-quantum:/config"
      - "/containers/filebrowser-quantum/srv:/srv"
    ports:
      - "8080:8080"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=filebrowser-quantum
PUID=1000
PGID=1000
TZ=UTC

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  filebrowser-quantum:
    name: filebrowser_quantum
    options:
      - container: 'args:--pull'
      - expose: '8080:8080 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
    volumes:
      - filebrowser-quantum: /config
      - filebrowser-quantum_srv: /srv
volumes:
  filebrowser-quantum:
    device: '/containers/filebrowser-quantum'
  filebrowser-quantum_srv:
    device: '/containers/filebrowser-quantum/srv'

Makejail:

# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/filebrowser-quantum:${tag}

Save the files above, then run appjail-director up.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.

Bastille

Warning

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  filebrowser-quantum:
    name: filebrowser-quantum
    image: "ghcr.io/daemonless/filebrowser-quantum:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
    volumes:
      - "/containers/filebrowser-quantum:/config"
      - "/containers/filebrowser-quantum/srv:/srv"

Save as bastille-compose.yml, then run bastille up.

Access at: http://localhost:8080

Parameters

Environment Variables

Variable Default Description
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container
FILEBROWSER_CONFIG `` Path to config.yaml. Defaults to /config/config.yaml; the container writes a minimal starter there on first boot if absent.

Volumes

Path Description
/config Configuration (config.yaml) and the database
/srv Default mount point for the files you want to browse. Mount one or more sources here and declare them under server.sources in config.yaml.

Ports

Port Protocol Description
8080 TCP

Architectures: amd64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15.1


Need help? Join our Discord community.

About

Self-hosted web file manager with fast indexed search, granular share controls, and modern authentication (OIDC, LDAP, 2FA).

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages