anders
/
ARC_Starter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated README, major changes to project.

This commit is contained in:
Anders Knutsen 2025-08-05 13:56:12 +02:00
parent 68d10967db
commit e0aece5320
1 changed files with 63 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
README.md
View File

@ -1,25 +1,81 @@
First working TCP SIA-DC09 logger. Logs to mariadb. Alarm handling software for ARC's.
No frontend, just a backend with mariadb and a TCP server that parses SIA-DC09 protocol data. Backend with mariadb and a TCP server that parses SIA-DC09 protocol data.
Frontend for managing TCP Receivers, users and view the signal log.
How to run: How to run:
``` ```
1. Install docker and docker compose. 1. Install docker and docker compose.
2. Modify docker-compose.yml to fit your needs, remember to change passwords! 2. Modify docker-compose.yml to fit your needs, remember to change passwords!
3. Run "docker compose build --no-cache" in root directory. 3. Modify config.ini, set loglevel, mariadb info, and license.
4. Run "docker compose up -d" to start 4. Run "docker compose build --no-cache" in root directory.
5. Run "docker compose up -d" to start
6. Go to http://server-ip/ to login.
``` ```
Current folder structure: Current folder structure:
``` ```
.
├── backend ├── backend
│ └── tcp_sia_server.py │ ├── main.bin
│ ├── main.py
│ ├── tcp_sia_server.bin
│ ├── tcp_sia_server.py
│ ├── watchdog.bin
│ └── watchdog.py
├── config.ini
├── docker-compose.yml ├── docker-compose.yml
├── Dockerfile ├── Dockerfile
├── Dockerfile.php
├── frontend ├── frontend
│ └── index.html │ ├── add_user.php
│ ├── auth.php
│ ├── composer.json
│ ├── composer.lock
│ ├── create_user.php
│ ├── db.php
│ ├── edit_user.php
│ ├── footer.php
│ ├── get_signals.php
│ ├── header.php
│ ├── index.php
│ ├── lang
│ │ ├── en.php
│ │ ├── no.php
│ │ └── translate.php
│ ├── login.php
│ ├── logout.php
│ ├── receivers.php
│ ├── receiver_status.php
│ ├── signal_log.php
│ ├── vendor
│ │ ├── autoload.php
│ │ ├── composer
│ │ │ ├── autoload_classmap.php
│ │ │ ├── autoload_namespaces.php
│ │ │ ├── autoload_psr4.php
│ │ │ ├── autoload_real.php
│ │ │ ├── autoload_static.php
│ │ │ ├── ClassLoader.php
│ │ │ ├── installed.json
│ │ │ ├── installed.php
│ │ │ ├── InstalledVersions.php
│ │ │ ├── LICENSE
│ │ │ └── platform_check.php
│ │ └── phpgangsta
│ │ └── googleauthenticator
│ │ ├── composer.json
│ │ ├── LICENSE.md
│ │ ├── PHPGangsta
│ │ │ └── GoogleAuthenticator.php
│ │ ├── README.md
│ │ └── tests
│ │ ├── bootstrap.php
│ │ ├── GoogleAuthenticatorTest.php
│ │ └── phpunit.xml
│ └── verify_2fa.php
├── nginx ├── nginx
│ └── nginx.conf │ └── nginx.conf
├── README.md ├── README.md
├── requirements.txt
└── sia-tester.py └── sia-tester.py
``` ```