Updated README, major changes to project.
This commit is contained in:
parent
68d10967db
commit
e0aece5320
70
README.md
70
README.md
|
|
@ -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:
|
||||
```
|
||||
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
|
||||
3. Modify config.ini, set loglevel, mariadb info, and license.
|
||||
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:
|
||||
```
|
||||
.
|
||||
├── 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
|
||||
├── Dockerfile
|
||||
├── Dockerfile.php
|
||||
├── 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.conf
|
||||
├── README.md
|
||||
├── requirements.txt
|
||||
└── sia-tester.py
|
||||
|
||||
```
|
||||
Loading…
Reference in New Issue