From cd65f6ab2206e7f95850d156fe2f4de9d1dec714 Mon Sep 17 00:00:00 2001 From: Michael Date: Mon, 31 Mar 2025 15:34:48 +0200 Subject: [PATCH] feat(readme): add docker install instructions --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index d3f557368..a09304b2f 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,26 @@ This will be complemented by a new web application (hereafter referred to as "Si This application will replicate the functions of the previous one while integrating new features, providing a more intuitive and simple user experience thanks to a new graphic design agreed upon. +## Build and run the containers + +Currently only the dev version of the project is being developed, the branch to be used is main. + +Ensure docker is installed and its service is up and running +One can quickly test docker by running: docker run hello-world + +Edit the file docker/config.yml by adding to the local url the public url (for dev add http://127.0.0.1:9876) +Add a string to the api_key and secret_key field, for dev it can be any random string + +Copy or rename the file .env.dev to .env + +Run the following command: +docker compose -f docker-compose.yml -f docker-compose.override.yml build && docker compose up -d + +This commands builds the docker containers in dev mode, then il will attempt to start them up. + +The sintonia web app is reachable on the port indicated in the env var SINTONIA_LARAVEL_PORT, by default the port is 9876. +So proceed to open a browser, connect to http://127.0.0.1:9876 (if no config or vars were changed). +Usually the user created by default is login: admin password: admin ## Support Coming soon