Personal fork which should enable working recovery emails and registration without hassle.

This also enables to set a custom system email address via setting 'app_email' in the config.php, similar to 'app_name'

Xbackbone is a simple, self-hosted, lightweight PHP file manager that support the instant sharing tool ShareX and *NIX systems. It supports uploading and displaying images, GIF, video, code, formatted text, and file downloading and uploading. Also have a web UI with multi user management, past uploads history and search support.

Application Setup

Access the WebUI at <your-ip>:80/443. Follow the installation wizard. For more information, check out XBackBone.

If you want to change the PHP max upload size you can override the php.ini file by adding options in /config/php/php-local.ini

Example:

  upload_max_filesize = 25M
  post_max_size = 25M

For reverse proxying, remember to change the base_url in /config/www/xbackbone/config.php to your domain if you initially set up the application with a local url. E.g. 'base_url' => 'https://images.yourdomain.com',

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

docker-compose (recommended, click here for more info)

---
services:
  xbackbone:
    image: mainfrezzer/xbackbone:latest
    container_name: xbackbone
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - SMTP_SERVER=SMTP-Server-Address
      - SMTP_PORT=465 or 587
      - SMTP_USERNAME=Login-Name
      - SMTP_PASSWORD=Password
    volumes:
      - /path/to/xbackbone/config:/config
    ports:
      - 80:80
      - 443:443
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=xbackbone \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e SMTP_SERVER=SMTP-Server-Address \
  -e SMTP_PORT=465 or 587 \
  -e SMTP_USERNAME=Login-Name \
  -e SMTP_PASSWORD=Password \
  -p 80:80 \
  -p 443:443 \
  -v /path/to/xbackbone/config:/config \
  --restart unless-stopped \
  mainfrezzer/xbackbone:latest

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Parameter	Function
-p 80	http gui
-p 443	https gui
-e PUID=1000	for UserID - see below for explanation
-e PGID=1000	for GroupID - see below for explanation
-e TZ=Etc/UTC	specify a timezone to use, see this list.
-e SMTP_SERVER	for the external SMTP-Server
-e SMTP_PORT	for the Port of the external SMTP-Server
-e SMTP_USERNAME	username for authentication with the SMTP-Server
-e SMTP_PASSWORD	the password for the user of the SMTP-Server
-v /config	Persistent config files

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

• Shell access whilst the container is running:

  docker exec -it xbackbone /bin/bash

• To monitor the logs of the container in realtime:

  docker logs -f xbackbone

• Container version number:

  docker inspect -f '{{ index .Config.Labels "build_version" }}' xbackbone

• Image version number:

  docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/xbackbone:latest

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose

• Update images:

  • All images:

    docker-compose pull

  • Single image:

    docker-compose pull xbackbone

• Update containers:

  • All containers:

    docker-compose up -d

  • Single container:

    docker-compose up -d xbackbone

• You can also remove the old dangling images:

  docker image prune

Via Docker Run

• Update the image:

  docker pull lscr.io/linuxserver/xbackbone:latest

• Stop the running container:

  docker stop xbackbone

• Delete the container:

  docker rm xbackbone

• Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)

• You can also remove the old dangling images:

  docker image prune

Image Update Notifications - Diun (Docker Image Update Notifier)

Tip

We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-xbackbone.git
cd docker-xbackbone
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/xbackbone:latest .

The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static

docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

• 27.05.24: - Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings.
• 28.12.23: - Rebase to Alpine 3.19 with php 8.3.
• 25.12.23: - Existing users should update: site-confs/default.conf - Cleanup default site conf.
• 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
• 13.04.23: - Move ssl.conf include to default.conf.
• 19.01.23: - Rebase to alpine 3.17 with php8.1.
• 04.11.22: - Rebase to Alpine 3.16, migrate to s6v3.
• 01.11.22: - Move application install to /app/www/public, add migration notices for existing users. Container updates should now update the application correctly
• 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
• 02.08.22: - Added note about updating.
• 06.06.21: - Initial Release.