transistor1/docker-inboxen

🐳 Inboxen Docker image based on Alpine Linux

⚠️ Abandoned project

This project is not maintained anymore and is abandoned. Feel free to fork and make your own changes if needed.

About

🐳 Inboxen Docker image based on Alpine Linux.
If you are interested, check out my other 🐳 Docker images!

💡 Want to be notified of new releases? Check out 🔔 Diun (Docker Image Update Notifier) project!

Features

• Inboxen WSGI daemon served through uWSGI and Nginx
• Nginx serves /static/ from app/static content through Django collectstatic
• Salmon mail server available through port 8823
• Celery served as a distributed task queue for RabbitMQ
• Automatic DB migration
• Traefik as reverse proxy and creation/renewal of Let's Encrypt certificates
• PostgreSQL image as database instance
• RabbitMQ image for message queue

Docker

Environment variables

General

• TZ : The timezone assigned to the container and Inboxen (default UTC)
• PUID : Inboxen user id (default 1000)
• PGID: Inboxen group id (default 1000)
• DB_TIMEOUT : Time in seconds after which we stop trying to reach the PostgreSQL server (default 30)

Inboxen

The following environment variables allow to populate the settings.ini for Inboxen.

General

• IB_ADMIN_EMAILS : See general / admin_emails setting
• IB_ADMIN_NAMES : See general / admin_names setting
• IB_ALLOWED_HOSTS : See general / allowed_hosts setting (default *)
• IB_DEBUG : See general / debug setting (default false)
• IB_ENABLE_REGISTRATION : See general / enable_registration setting (default false)
• IB_ENABLE_USER_EDITING : See general / enable_user_editing setting (default false)
• IB_LANGUAGE_CODE : See general / language_code setting (default en-gb)
• IB_LOGIN_ATTEMPT_COOLOFF : See general / login_attempt_cooloff setting (default 10)
• IB_LOGIN_ATTEMPT_LIMIT : See general / login_attempt_limit setting (default 5)
• IB_REGISTER_LIMIT_WINDOW : See general / register_limit_window setting (default 1440)
• IB_REGISTER_LIMIT_COUNT : See general / register_limit_count setting (default 100)
• IB_SECRET_KEY : See general / secret_key setting
• IB_SERVER_EMAIL : See general / server_email setting (default docker-inboxen@localhost)
• IB_SITE_NAME : See general / site_name setting (default Docker Inboxen)
• IB_SOURCE_LINK : See general / source_link setting (default https://github.com/Inboxen/Inboxen)
• IB_PER_USER_EMAIL_QUOTA : See general / per_user_email_quota setting (default 0)

Inbox

• IB_INBOX_LENGTH : See inbox / inbox_length setting (default 5)
• IB_INBOX_LIMIT_WINDOW : See inbox / inbox_limit_window setting (default 1440)
• IB_INBOX_LIMIT_COUNT : See inbox / inbox_limit_count setting (default 100)

Tasks

• IB_TASKS_BROKER_URL : See tasks / broker_url setting (default amqp://guest:guest@localhost:5672//)
• IB_TASKS_CONCURRENCY : See tasks / concurrency setting (default 3)
• IB_LIBERATION_SENDFILE_METHOD : See tasks / liberation / sendfile_method setting (default simple)

Database

• IB_DB_NAME : See database / name setting (default inboxen)
• IB_DB_USER : See database / user setting
• IB_DB_PASSWORD : See database / password setting
• IB_DB_HOST : See database / host setting
• IB_DB_PORT : See database / port setting

Cache

• IB_CACHE_TIMEOUT : See cache / timeout setting (default 300)

Volumes

• /data : Contains cache, media, logs and liberation data

Ports

• 8080 : HTTP port of Nginx
• 8823 : SMTP port for Salmon mail server

Use this image

Docker Compose

Docker compose is the recommended way to run this image. You can use the following docker compose template, then run the container :

touch acme.json
chmod 600 acme.json
docker-compose up -d
docker-compose logs -f

Notes

Add super user

On first launch, you will have to create a super user to handle administration through /admin :

$ docker-compose exec --user inboxen inboxen sh -c ". env/bin/activate && ./manage.py createsuperuser --username <username> --email <email>"
Password:
Password (again):
Superuser created successfully.

⚠️ Substitute your desired username <username> and email address <email>

Upgrade

To upgrade to the latest version, pull the newer image and launch the container. Inboxen will upgrade automatically :

docker-compose pull
docker-compose up -d

How can I help ?

All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬 You can also support this project by becoming a sponsor on GitHub 👏 or by making a Paypal donation to ensure this journey continues indefinitely! 🚀

Thanks again for your support, it is much appreciated! 🙏

License

MIT. See LICENSE for more details.