bitcast/bubbles repository overview

⁠Bubbles

Bubbles is a SCUBA equipment management system for dive clubs. It manages equipment details and rentals by members.

⁠Overview

This image contains the Django application that contains the business logic. It listens for connections on port 8000. It does not include a web-server for serving static content, that needs to be configured by the user. The accompanying Nginx image⁠ can be used for that purpose. It requires a Database connection and a volume mapped to /app/staticfiles for the static files served by the web server.

⁠Running

To run the container and bind the port 8000 to the host machine; run the following:

docker run -p 8000:8000 -v -v static:/app/staticfiles bitcast/bubbles

The web server can then proxy connections to bubbles:8000 and map the location /static/ to the volume static.

⁠Configuration

The image supports the following environment variables:

⁠SQLite:

• SQL_DATABASE - the file path for the database, defaults to /app/db.sqlite3

⁠PostgreSQL, MySQL, MariaDB:

• SQL_ENGINE - the Django database engine to use (django.db.backends.postgresql for example)
• SQL_DATABASE - the name of the database
• SQL_USER - the username to use
• SQL_PASSWORD - the password to use
• SQL_HOST - the hostname of the database
• SQL_PORT - the port to connect on

⁠Django Configuration

• DJANGO_SETTINGS_MODULE - the settings module to use. By default this is bubbles.settings.prod.
• DJANGO_DEBUG - if this is set, DJango will provide debug output to the web client. Only use this for debugging and not running in production
• SECRET_KEY - the secret key that is unique to the Django installation. See the Django documentation⁠
• USER_USERNAME - The default super-user to create. Leave this blank to not create a default super-user
• USER_EMAIL - the default user's email address
• USER_PASSWORD - the default user's password

Additional configuration can be performed in a python script that imports everything from bubbles.settings.prod (from bubbles.settings.prod import *) and then setting DJANGO_SETTINGS_MODULE to the path to that file with all / replaced with . (e.g. for /opt/settings.py it would be opt.settings).