ATVG-OpenCAD-Docker-Distribution

Project ID: 134

Issue tracking for the "ATVG OpenCAD Docker" distribution by ATVG-Studios.

Archived project! Repository and other project resources are read-only

The Image

This is the "ATVG OpenCAD Docker" distribution, with a non-modified OpenCAD version.

What is OpenCAD?

OpenCAD is an open source computer aided dispatch system for roleplay communities written in PHP

Get the source from github or ~~repo.opencad.io~~

How is this possible?

In the OpenCAD 0.2.6 beta a web installer was added. We simply install the fresh copy of OpenCAD into a container and the user then has to use the Web Installer to get OpenCAD configured.

The OpenCAD 0.2.6 beta was released as 0.3.0 stable, as the image is version agnostic it was able to support the stable right after release.

Somethings wrong!

Please send bug reports of OpenCAD to the OpenCAD team, and only bugs in the actual OpenCAD Docker Image to ATVG-Studios.

Issue Tracking for OpenCAD
Issue Tracking for this OpenCAD Docker Distribution Image

About this Image

This is a docker image containing OpenCAD running on Alpine 3.11 with Apache2, PHP 7 and MariaDB.

Versions

stable - Stable build of release/stable (Production)
beta- Semi-Stable build of release/beta (Testing)
canary - Unstable build of release/canary (Development)

Please note that latest is the same as stable.

How to use this image?

Latest Stable Version

Run:

docker run -td atvgstudios/opencad:stable

Specific Stable Version

Run:

docker run -td atvgstudios/opencad:0.3.2

Testing/Beta Version

Run:

docker run -td atvgstudios/opencad:beta

Development/Canary Version

Run:

docker run -td atvgstudios/opencad:canary

Higher Security

Starting since the OpenCAD 0.3.2 distribution, the Database password can be regenerated at runtime, this is an important security feature because by default all containers have the same date-based password.

When adding the GEN_NEW_PASSWORD variable with yes (-e GEN_NEW_PASSWORD="yes"), the script rebuilds the database with the new password.

This can happen on existing databases yet the password must be changed in the OpenCAD configuration file, this is a manual step that has to be done using the shell.

External Database

Starting since the OpenCAD 0.3.2 distribution, the Database can be made external by adding a Volume: -v /local/path/to/database:/var/lib/mysql

This will cause a database rebuild, including the generation of a new password. The above "GEN_NEW_PASSWORD" environment variable can thus be left away.

Example:

docker run -td -v /tmp/opencad:/var/lib/mysql atjontv/opencad:stable

Existing Config

It was always possible to add your own configuration right away, yet this can be an issue when the database is empty as with a configuration the installer wont run.

Adding a existing config is as simple as adding a read-only volume:

Example:

docker run -td -v /tmp/oc-config.php:/opt/opencad/oc-config.php:ro

IMPORTANT note about Canary!

The canary build does not only contain the latest development code, but also phpmyadmin for working on the database.

The phpmyadmin login username is root and the password can be seen by visiting http://IP/.dbpasswd.

Do NOT use this build type in production! It contains unstable code and (with phpmyadmin) a open database!

Container License

The ATVG OpenCAD Docker Distribution image is released under the following Terms:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, publish and/or distribute the Software, and to permit persons to whom the Software is furnished to do so.

The Software is defined as the Dockerfiles used to build the Image, the Image itself, as well as the following files inside the Image:

/xbin/init, /xbin/init2, /xbin/install, /xbin/canaray-update

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.