Closed phil-flip closed 23 hours ago
π Thanks for this pull request! π
We use semantic commit messages to streamline the release process and easily generate changelogs between versions. Before your pull request can be merged, you should update your pull request title to start with a semantic prefix if it doesn't have one already.
Examples of commit messages with semantic prefixes:
Fixed #<issue number>: don't overwrite prevent_default if default wasn't prevented
Added #<issue number>: add checkout functionality to assets
Improved Asset Checkout: use new notification method for checkout
Things that will help get your PR across the finish line:
We get a lot of pull requests on this repo, so please be patient and we will get back to you as soon as we can.
Introduction of a new .env.dev.docker file This new file holds various settings for fine-tuning the application, including those related to database setup, application settings, file storage, mail server, image library, backup policies, session management, security measures, cache operations, Redis configurations, AWS settings, login throttling, and miscellaneous ones.
Alterations to .env.docker file
The current .env.docker
file has been updated to optimally configure the application for a production environment. The app now runs on port 8000. New parameters for the database root password and app settings that enable deletion of backups and data purging have been added. Alterations were also made to the database and Redis host settings.
Addition of dev.docker-compose.yml file A new file to run the application in a development environment using Docker Compose has been added. It comprises services for the main application 'snipeit', database 'mariadb', 'redis' for in-memory data structure store, and 'mailhog' as a mail testing tool.
Updates to docker-compose.yml file The primary Docker Compose file has been modified. Volumes have been added for improved data management. The main 'snipeit' service now uses a specific version of 'snipe-it' image. Restart policies have been established to maintain continuous service availability. Data storage for the application and database have been assigned to 'storage' and 'db_data' respectively. A health check function for our database service is now implemented for monitoring its performance. Finally, updates have been done to the environment variables. ``
Thankies for the compliments. ^^ I had a feeling that because of the upcoming release there are not going to be made a lot of changes to v6. Tho I would prefer to merge it now as it should make a difference, unless the application stack changes (different DB, other backend, etc...)
Thank you β€οΈ
Congrats on merging your first pull request! πππ
@snipe Thank you for merging. Mind also merging the changes in the Docs?
Done :)
Description
For a while now @svpernova09 and I have been planning on rewriting the Docker Docs so it uses Docker compose, instead of Docker run. That requires us to change some stuff in the repo. Like having a
docker-compose.yml
and.env.docker
file which can be used by the user.This Pr should help with getting less support inquiries in the Discord Docker channel and remove
docker run
from production deployments.Thankies to @svpernova09 for helping me brainstorm about possible solutions and providing the health checks for the
docker-compose.yml
Type of change
How Has This Been Tested?
The updated article can be read in the docs. But I tested my setup, by running the following commands.
.env.docker
to.env
.env
, if neededdocker compose up -d
and wait for startupdocker compose down
to remove deployment, but not the volumesdocker compose up -d
and wait for startupdocker compose down -v
delete deployment and dataChecklist: