pe46dro/xbackbone-docker repository overview

⁠About this Repo

This is the Docker image for XBackBone⁠ ~ based on webdevops/php-nginx⁠.

⁠Supported tags and respective Dockerfile

• [latest (THIS REPO/src/Dockerfile)]
• [3.3,3.3.3 (src/Dockerfile)]
• [3.2,3.2.0 (src/Dockerfile)]
• [3.1,3.1.4 (src/Dockerfile)]
• [3.0,3.0.2, (src/Dockerfile)]
• [2.6,2.6.5 (src/Dockerfile)]
• [2.6.3 (src/Dockerfile)]
• [2.6.0 (src/Dockerfile)]
• [2.5,2.5.3 (src/Dockerfile)]
• [2.5.0 (src/Dockerfile)]
• [2.4, 2.4.1, (src/Dockerfile)]
• dev (dev/src/Dockerfile)⁠

⁠Quick reference

• Where to file issues:
  https://github.com/Pe46dro/XBackBone-docker/issues⁠

• Supported architectures: amd64

• Supported Docker versions:
  the latest release⁠ (down to 1.6 on a best-effort basis)

⁠How to use this image

You can use the following command to start the container and map the ports to the host:

$ docker run -p 80:80 \
    -e APP_NAME=XBackBone \
    -e URL=http:\/\/127.0.0.1 \
    --name xbb \
    pe46dro/xbackbone-docker

⁠Container shell access

Nginx erver log is available through Docker's container log:

$ docker logs xbb

⁠Environment Variables

When you start this image, you can adjust the configuration by passing one or more environment variables on the docker run command line.

⁠APP_NAME

This will specify the app name, if none is provided the default is XBackBone -e APP_NAME=XBackBone

⁠URL

This will specify the app url, slashes need to be escaped like follow -e URL=http:\/\/127.0.0.1

⁠GENERATE_RELEASE=TRUE dev-only

If set, this environment variable will generate a release zip and will place it on srv/xbb/storage

⁠Build Args Variables

When you build the image yourself, you can adjust the version using the --build-arg variable=value parameter on the docker build command line.

⁠XBACKBONE_VERSION

You can specify the tag from XBackBone⁠ release and download the desired one

⁠Where to Store Data

⁠Available mount point

• /app/storage
• /app/resources/database
• /app/logs
• /app/config (to keep config files - Docker container only)

⁠Permissions

The folder on host system need to have both UID and GID 1000

⁠PHP Customization

You can specify eg. php.memory_limit=256M as dynamic env variable which will set memory_limit = 256M as php setting. Refer to webdevops documentation⁠ for more details

⁠Example

mkdir -p /srv/xbb/storage
mkdir -p /srv/xbb/database
mkdir -p /srv/xbb/logs
mkdir -p /srv/xbb/config

chown -R 1000:1000 /srv/xbb

⁠MySQL Database

• Clone repo
• Customize ENV flags in xbb.env
• Build and run

git clone https://github.com/Pe46dro/XBackBone-docker.git .
docker-compose up -d

⁠LDAP Authentication

The following environment variables are available to configure LDAP authentication:

• LDAP_ENABLED
• LDAP_HOST
• LDAP_PORT
• LDAP_BASE_DOMAIN
• LDAP_USER_DOMAIN
• LDAP_RDN_ATTRIBUTE

See the docs⁠ for explanation.

⁠Upgrade from version < 3.1.4

Run the following command before performing the upgrade: echo '-' > YOUR_STORAGE_VOLUME/storage/.installed

⁠Mantainer

• Pe46dro⁠ - Creator

⁠License

View license information⁠ for the software contained in this image.