Skip to content

Latest commit

 

History

History
90 lines (54 loc) · 3.45 KB

README.md

File metadata and controls

90 lines (54 loc) · 3.45 KB
Raw

Sourcebans Docker Image

Docker Image for SourceBans++

Project state

This project is deprecated as the underlying SourceBans++ version and base image are heavily outdated.

Getting Started

These instructions will cover usage information for the docker container

Prerequisities

In order to run this container you'll need docker installed.

Usage

Quickstart

If you use Docker Compose there is an example docker-compose.yml file you can use for fast setup.

Create a Docker network

docker network create sourcebans-db

Start a MariaDB container

docker run -d --volume sourcebans-mysql:/var/lib/mysql/ --network sourcebans-db \
    --env MYSQL_DATABASE=sourcebans --env MYSQL_USER=sourcebans --env MYSQL_PASSWORD=ThisShouldBeAStrongPassword --env MYSQL_ROOT_PASSWORD=ThisShouldBeAStrongPassword \
    --name sourcebans-mariadb mariadb:5

Start the Sourcebans container that is based on the official PHP Docker Image.

docker run -d -p 80:80 --volume sourcebans:/var/www/html/ --network sourcebans-db --name sourcebans crinis/sourcebans:latest

Connect to your Docker host on port 80 and go through the setup process at yourhost/install in your browser using your specified credentials for the MySQL container and sourcebans-mariadb if not otherwise specified as the database host.

After completing the installation steps you first need to stop the sourcebans container...

docker rm -f sourcebans

... and restart while setting the REMOVE_SETUP_DIRS environment variable to "true". This will remove your install/ and updater/ directories.

docker run -d -p 80:80 --volume sourcebans:/var/www/html/ --network sourcebans-db --env REMOVE_SETUP_DIRS=true --name sourcebans crinis/sourcebans:latest

Now visit Sourcebans in your browser.

Environment Variables

  • REMOVE_SETUP_DIRS - Removes the install/ and updater/ directories. You have to set this to "true" after installing or updating your installation

Volumes

  • /var/www/html/ - Contains the Sourcebans installation

Useful File Locations

  • /usr/local/etc/php/conf.d/sourcebans.ini - The Sourcebans specific PHP configuration that overrides defaults

Limitations

This image does not support automatic updates of SourceBans++ yet, even if you update to a newer version of this image. To update you should follow the normal update instructions inside the container.

Docker Image Tags

I recommend to use the Docker image tags starting with the Git tags of this repository as images containing older Sourcebans Versions might be changed and not be compatible.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Felix Spittel - Initial work - Crinis

License

This project is licensed under the MIT License - see the LICENSE.md file for details. The image contains software that use different licenses.