Skip to content

Getting Started

Get started by running the server on your host and accessing the site.

You can also view the 🛠️ Features and 📸 Screenshots.

Running

The fastest way to get up and running is with Docker.

shell
version: '3'

services:
  django-files:
    image: ghcr.io/django-files/django-files:latest
    environment:
      USERNAME: "myadminuser"
      PASSWORD: "pleasechangeme"
    volumes:
      - media_dir:/data/media
    ports:
      - "80:80"

volumes:
  media_dir:
shell
docker run --name "django-files" -d --restart unless-stopped  \
  -p 80:80  -v /data/django-files:/data/media  \
  -e USERNAME=myadminuser  \
  -e PASSWORD=pleasechangeme  \
    ghcr.io/django-files/django-files:latest

Note: you can run from source; however, this is currently not documented or supported.

Accessing

Once the server is up and running you can access the site from a web browser.

If running on your localhost with default port mapping, you can access it here:

If you set a USERNAME or PASSWORD environment variable, use those values.

Otherwise, the default credentials are.

DefaultValue
usernameadmin
password12345

Next you can review the server setup and start uploading or check out the features.