Update README.md

This commit is contained in:
Michael 2025-04-02 12:57:16 +02:00
parent c0039d7c47
commit f2c2e5a8e0

View file

@ -25,7 +25,12 @@ Currently only the dev version of the project is being developed, the branch to
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)
This repo contains a git submodule sintonia_webapp, it refers to this [repo](https://git.congegni.net/Congegni/sintonia_webapp).
To pull the repo, open a terminal in the root of this project and run this command:
git submodule update --init --recursive --remote && cd sintonia_webapp && git checkout dev && cd ..
The folder sintonia_webapp now it's synced with the dev branch (the currently active branch).
In the sintonia folder, 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
@ -38,6 +43,27 @@ This commands builds the docker containers in dev mode, then il will attempt to
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
## HW usage
The stats below refer to the containers without any load and some test data
docker stats --no-stream
CONTAINER ID NAME CPU % MEM USAGE / LIMIT MEM % NET I/O BLOCK I/O PIDS
fdc43da14053 sintonia-postgres-1 0.33% 236.7MiB / 30.95GiB 0.75% 86.4MB / 45.2MB 1.11GB / 906MB 9
74c48a47033c sintonia-liquidsoap-1 23.00% 78.48MiB / 30.95GiB 0.25% 113MB / 2.61GB 281MB / 0B 12
f97521670581 sintonia-playout-1 0.00% 43.95MiB / 30.95GiB 0.14% 39.9MB / 6.85MB 52.5MB / 0B 2
5c8bf1fe4e61 sintonia-legacy-1 0.01% 64.21MiB / 30.95GiB 0.20% 24.4MB / 24.2MB 136MB / 0B 5
b868aad49ccc sintonia-nginx-1 0.00% 11.46MiB / 30.95GiB 0.04% 96MB / 110MB 36.4MB / 0B 9
e89bf2b1a732 sintonia-worker-1 0.20% 96.11MiB / 30.95GiB 0.30% 8.93MB / 8.26MB 45.8MB / 2.03MB 4
e18346d6b201 sintonia-analyzer-1 0.02% 32.97MiB / 30.95GiB 0.10% 454kB / 106kB 34.8MB / 0B 3
7341e6559130 sintonia-webapp-dev 0.09% 492.6MiB / 30.95GiB 1.55% 46.3MB / 254MB 742MB / 28.1MB 41
959c88dc8a46 sintonia-api-1 4.39% 121.4MiB / 30.95GiB 0.38% 395kB / 79kB 83.6MB / 0B 4
### RAM
1177.88MB
### Images size
4460.7MB
## Support
Coming soon