docker-documentation/images/docker-xbackbone.md

179 wiersze
9.4 KiB
Markdown
Czysty Zwykły widok Historia

2021-06-06 19:27:32 +00:00
---
title: xbackbone
---
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker-xbackbone/blob/main/.github/CONTRIBUTING.md -->
# [linuxserver/xbackbone](https://github.com/linuxserver/docker-xbackbone)
2021-12-23 14:37:04 +00:00
[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fxbackbone?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fxbackbone)
2021-06-06 19:27:32 +00:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-xbackbone.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-xbackbone)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-xbackbone.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-xbackbone/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-xbackbone/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-xbackbone/container_registry)
2021-10-07 14:36:38 +00:00
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/xbackbone)
2021-06-06 19:27:32 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/xbackbone.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/xbackbone)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/xbackbone.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/xbackbone)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-xbackbone%2Fjob%2Fmain%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-xbackbone/job/main/)
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fxbackbone%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/xbackbone/latest/index.html)
2021-06-06 20:50:22 +00:00
[Xbackbone](https://github.com/SergiX44/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.
2021-06-06 19:27:32 +00:00
## Supported Architectures
2022-05-05 14:38:30 +00:00
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2021-06-06 19:27:32 +00:00
2022-05-05 14:38:30 +00:00
Simply pulling `lscr.io/linuxserver/xbackbone:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2021-06-06 19:27:32 +00:00
The architectures supported by this image are:
2022-05-05 14:38:30 +00:00
| Architecture | Available | Tag |
| :----: | :----: | ---- |
| x86-64 | ✅ | amd64-\<version tag\> |
| arm64 | ✅ | arm64v8-\<version tag\> |
2023-05-30 13:48:04 +00:00
| armhf | ❌ | |
2021-06-06 19:27:32 +00:00
## Application Setup
2021-06-06 20:50:22 +00:00
Access the WebUI at \<your-ip>:80/443. Follow the installation wizard. For more information, check out [XBackBone](https://github.com/SergiX44/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:
```ini
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',`
2021-06-06 19:27:32 +00:00
## Usage
2021-07-08 14:39:47 +00:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2021-06-06 19:27:32 +00:00
2021-07-08 14:39:47 +00:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2021-06-06 19:27:32 +00:00
```yaml
---
version: "2.1"
services:
xbackbone:
2022-05-05 14:38:30 +00:00
image: lscr.io/linuxserver/xbackbone:latest
2021-06-06 19:27:32 +00:00
container_name: xbackbone
environment:
- PUID=1000
- PGID=1000
2023-02-16 14:36:55 +00:00
- TZ=Etc/UTC
2021-06-06 19:27:32 +00:00
volumes:
- /path/to/data:/config
ports:
- 80:80
- 443:443
restart: unless-stopped
```
2021-07-08 14:39:47 +00:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2021-06-06 19:27:32 +00:00
```bash
docker run -d \
--name=xbackbone \
-e PUID=1000 \
-e PGID=1000 \
2023-02-16 14:36:55 +00:00
-e TZ=Etc/UTC \
2021-06-06 19:27:32 +00:00
-p 80:80 \
-p 443:443 \
-v /path/to/data:/config \
--restart unless-stopped \
2022-05-05 14:38:30 +00:00
lscr.io/linuxserver/xbackbone:latest
2023-02-16 14:36:55 +00:00
2021-06-06 19:27:32 +00:00
```
## Parameters
Docker images 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.
### Ports (`-p`)
| Parameter | Function |
| :----: | --- |
| `80` | http gui |
| `443` | https gui |
### Environment Variables (`-e`)
| Env | Function |
| :----: | --- |
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2023-02-16 14:36:55 +00:00
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
2021-06-06 19:27:32 +00:00
### Volume Mappings (`-v`)
| Volume | Function |
| :----: | --- |
| `/config` | config directory volume mapping |
2021-10-07 14:36:38 +00:00
#### Miscellaneous Options
| Parameter | Function |
| :-----: | --- |
2021-06-06 19:27:32 +00:00
## Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
```bash
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` 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](https://en.wikipedia.org/wiki/Umask) 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 user` as below:
```bash
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
## Docker Mods
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=xbackbone&query=%24.mods%5B%27xbackbone%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=xbackbone "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
We publish various [Docker Mods](https://github.com/linuxserver/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
2022-05-05 14:38:30 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/xbackbone:latest`
2021-06-06 19:27:32 +00:00
## Versions
2023-05-30 13:48:04 +00:00
* **25.05.23:** - Rebase to Alpine 3.18, deprecate armhf.
2023-04-15 15:27:19 +00:00
* **13.04.23:** - Move ssl.conf include to default.conf.
2023-01-21 19:08:43 +00:00
* **19.01.23:** - Rebase to alpine 3.17 with php8.1.
2022-11-03 19:02:11 +00:00
* **04.11.22:** - Rebase to Alpine 3.16, migrate to s6v3.
2022-11-02 16:48:07 +00:00
* **01.11.22:** - Move application install to /app/www/public, add migration notices for existing users. Container updates should now update the application correctly
2022-08-20 17:52:09 +00:00
* **20.08.22:** - Rebasing to alpine 3.15 with php8. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base)).
* **02.08.22:** - Added note about updating.
* **06.06.21:** - Initial Release.