From b05d4f143af22634e7ded92e06ebc0d3b81f3f02 Mon Sep 17 00:00:00 2001 From: Anders Knutsen Date: Fri, 25 Jul 2025 10:32:23 +0200 Subject: [PATCH] Updated folder structrue and README --- README.md | 25 ++++++++++++------- .../tcp_sia_server.py | 0 docker-compose.yml | 2 +- nginx.conf => nginx/nginx.conf | 0 tester.py => sia-tester.py | 0 5 files changed, 17 insertions(+), 10 deletions(-) rename tcp_sia_server.py => backend/tcp_sia_server.py (100%) rename nginx.conf => nginx/nginx.conf (100%) rename tester.py => sia-tester.py (100%) diff --git a/README.md b/README.md index e76f223..2170b1e 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,23 @@ First working TCP SIA-DC09 logger. Logs to mariadb. No frontend, just a backend with mariadb and a TCP server that parses SIA-DC09 protocol data. +How to run: + 1. Install docker and docker compose. + 2. Modify docker-compose.yml to fit your needs, remember to change passwords! + 3. Run "docker compose build --no-cache" in root directory. + 4. Run "docker compose up -d" to start Current folder structure: ``` -├── docker-compose.yml -├── Dockerfile -├── frontend -│ └── index.html -├── nginx.conf -├── README.md -├── requirements.txt -├── tcp_sia_server.py -└── tester.py +├── backend +│ └── tcp_sia_server.py +├── docker-compose.yml +├── Dockerfile +├── frontend +│ └── index.html +├── nginx +│ └── nginx.conf +├── README.md +├── requirements.txt +└── sia-tester.py ``` \ No newline at end of file diff --git a/tcp_sia_server.py b/backend/tcp_sia_server.py similarity index 100% rename from tcp_sia_server.py rename to backend/tcp_sia_server.py diff --git a/docker-compose.yml b/docker-compose.yml index 7f0f374..2d18b95 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -17,7 +17,7 @@ services: image: nginx:stable volumes: - ./frontend:/usr/share/nginx/html:ro - - ./nginx.conf:/etc/nginx/nginx.conf:ro + - ./nginx/nginx.conf:/etc/nginx/nginx.conf:ro ports: - "80:80" depends_on: diff --git a/nginx.conf b/nginx/nginx.conf similarity index 100% rename from nginx.conf rename to nginx/nginx.conf diff --git a/tester.py b/sia-tester.py similarity index 100% rename from tester.py rename to sia-tester.py