Congegni/sintonia
7
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

feat(readme): add docker install instructions

Browse source
This commit is contained in:
Michael 2025-03-31 15:34:48 +02:00
parent 4431a346a6
commit cd65f6ab22
1 changed files with 20 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -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