Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Pe46dro/XBackBone-docker
This is the Docker image for XBackBone ~ based on webdevops/php-nginx.
https://github.com/Pe46dro/XBackBone-docker
docker dockerfile sharex
Last synced: about 2 months ago
JSON representation
This is the Docker image for XBackBone ~ based on webdevops/php-nginx.
- Host: GitHub
- URL: https://github.com/Pe46dro/XBackBone-docker
- Owner: Pe46dro
- License: gpl-3.0
- Created: 2018-10-13T18:21:37.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-06-13T14:07:54.000Z (over 1 year ago)
- Last Synced: 2024-06-10T13:44:29.891Z (3 months ago)
- Topics: docker, dockerfile, sharex
- Language: Shell
- Homepage:
- Size: 110 KB
- Stars: 16
- Watchers: 3
- Forks: 13
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# About this Repo
This is the Docker image for [XBackBone](https://github.com/SergiX44/XBackBone) ~ based on [webdevops/php-nginx](https://dockerfile.readthedocs.io/en/latest/content/DockerImages/dockerfiles/php-nginx.html).
# 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*)](https://github.com/Pe46dro/XBackBone-docker/tree/dev)
# Quick reference
- **Where to file issues**:
[https://github.com/Pe46dro/XBackBone-docker/issues](https://github.com/Pe46dro/XBackBone-docker/issues)
- **Supported architectures**: `amd64`
- **Supported Docker versions**:
[the latest release](https://github.com/docker/docker-ce/releases/latest) (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:
```console
$ 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:
```console
$ 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](https://github.com/SergiX44/XBackBone/releases) 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](https://dockerfile.readthedocs.io/en/latest/content/DockerImages/dockerfiles/php-nginx.html#php-ini-variables) for more details
| Environment variable | Description | Default |
|--------------------------------------- |----------------------------------------- |----------- |
| `php.{setting-key}` | Sets the `{setting-key}` as php setting | |
| `PHP_DATE_TIMEZONE` | `date.timezone` | `UTC` |
| `PHP_DISPLAY_ERRORS` | `display_errors` | `0` |
| `PHP_MEMORY_LIMIT` | `memory_limit` | `512M` |
| `PHP_MAX_EXECUTION_TIME` | `max_execution_time` | `300` |
| `PHP_POST_MAX_SIZE` | `post_max_size` | `50M` |
| `PHP_UPLOAD_MAX_FILESIZE` | `upload_max_filesize` | `50M` |
| `PHP_OPCACHE_MEMORY_CONSUMPTION` | `opcache.memory_consumption` | `256` |
| `PHP_OPCACHE_MAX_ACCELERATED_FILES` | `opcache.max_accelerated_files` | `7963` |
| `PHP_OPCACHE_VALIDATE_TIMESTAMPS` | `opcache.validate_timestamps` | `default` |
| `PHP_OPCACHE_REVALIDATE_FREQ` | `opcache.revalidate_freq` | `default` |
| `PHP_OPCACHE_INTERNED_STRINGS_BUFFER` | `opcache.interned_strings_buffer` | `16` |
| ``FPM_PROCESS_MAX`` | ``process.max`` | ``distribution default`` |
| ``FPM_PM_MAX_CHILDREN`` | ``pm.max_children`` | ``distribution default`` |
| ``FPM_PM_START_SERVERS`` | ``pm.start_servers`` | ``distribution default`` |
| ``FPM_PM_MIN_SPARE_SERVERS`` | ``pm.min_spare_servers`` | ``distribution default`` |
| ``FPM_PM_MAX_SPARE_SERVERS`` | ``pm.max_spare_servers`` | ``distribution default`` |
| ``FPM_PROCESS_IDLE_TIMEOUT`` | ``pm.process_idle_timeout`` | ``distribution default`` |
| ``FPM_MAX_REQUESTS`` | ``pm.max_requests`` | ``distribution default`` |
| ``FPM_REQUEST_TERMINATE_TIMEOUT`` | ``request_terminate_timeout`` | ``distribution default`` |
| ``FPM_RLIMIT_FILES`` | ``rlimit_files`` | ``distribution default`` |
| ``FPM_RLIMIT_CORE`` | ``rlimit_core`` | ``distribution default`` |
#### Example
```bash
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
```bash
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](https://xbackbone.app/configuration.html#ldap-authentication) for explanation.
# Manual configuration
Sometimes, it's more convenient to supply a `config.php` file yourself. To skip the
auto-configuration (and prevent mangling of the configuration), set the `SKIP_CONFIGURE` environment
variable to any value.
# Upgrade from version < 3.1.4
Run the following command before performing the upgrade:
`echo '-' > YOUR_STORAGE_VOLUME/storage/.installed`
# Mantainer
* [Pe46dro](https://github.com/Pe46dro) - Creator
# License
View [license information](LICENSE) for the software contained in this image.