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

Update README.md

Browse source
This commit is contained in:
Michael 2025-04-02 13:02:34 +02:00
parent f2c2e5a8e0
commit db1ac237c9
1 changed files with 25 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -23,29 +23,41 @@ This application will replicate the functions of the previous one while integrat
Currently only the dev version of the project is being developed, the branch to be used is main. 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 Ensure docker is installed and its service is up and running
One can quickly test docker by running: docker run hello-world One can quickly test docker by running: docker run hello-world
This repo contains a git submodule sintonia_webapp, it refers to this [repo](https://git.congegni.net/Congegni/sintonia_webapp). 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: 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 .. 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). 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) 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 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 Copy or rename the file .env.dev to .env
Run the following command: Run the following command:
`
docker compose -f docker-compose.yml -f docker-compose.override.yml build && docker compose up -d 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. 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. 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). 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 Usually the user created by default is login: admin password: admin
## HW usage ## HW usage
The stats below refer to the containers without any load and some test data The stats below refer to the containers without any load and some test data
`
docker stats --no-stream docker stats --no-stream
CONTAINER ID NAME CPU % MEM USAGE / LIMIT MEM % NET I/O BLOCK I/O PIDS 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 fdc43da14053 sintonia-postgres-1 0.33% 236.7MiB / 30.95GiB 0.75% 86.4MB / 45.2MB 1.11GB / 906MB 9
@ -57,6 +69,7 @@ e89bf2b1a732 sintonia-worker-1 0.20% 96.11MiB / 30.95GiB 0.30%
e18346d6b201 sintonia-analyzer-1 0.02% 32.97MiB / 30.95GiB 0.10% 454kB / 106kB 34.8MB / 0B 3 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 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 959c88dc8a46 sintonia-api-1 4.39% 121.4MiB / 30.95GiB 0.38% 395kB / 79kB 83.6MB / 0B 4
`
### RAM ### RAM
1177.88MB 1177.88MB