Update README

This commit is contained in:
Aelita4 2022-09-16 19:00:02 +02:00
parent 899f26ab35
commit a6d4c2c327
Signed by: Aelita4
GPG Key ID: E4773B4E7238A472
1 changed files with 5 additions and 95 deletions

100
README.md
View File

@ -3,105 +3,15 @@
## First configuration
1. Create docker image
- `$ docker build -t sshmon .`
- `$ docker build -t sshmon:surreal .`
2. Setup containers
- `$ docker-compose up -d`
- This will open ports 3306 for database, 8080 for main app and 8081 for phpMyAdmin
- This will open ports 8000 for database and 8080 for main app
3. Create database and tables
- Script does not create database and tables by default
- Create database `sshmon` with 3 tables:
<table>
<thead>
<tr>
<th colspan=3>ips</th>
</tr>
</thead>
<tbody>
<tr>
<td>Name</td>
<td>Type</td>
<td>Extra</td>
</tr>
<tr>
<td>id</td>
<td>int</td>
<td>AUTO_INCREMENT PRIMARY KEY</td>
</tr>
<tr>
<td>ip</td>
<td>varchar(255)</td>
<td></td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th colspan=3>users</th>
</tr>
</thead>
<tbody>
<tr>
<td>Name</td>
<td>Type</td>
<td>Extra</td>
</tr>
<tr>
<td>id</td>
<td>int</td>
<td>AUTO_INCREMENT PRIMARY KEY</td>
</tr>
<tr>
<td>username</td>
<td>varchar(255)</td>
<td></td>
</tr>
<tr>
<td>password</td>
<td>varchar(255)</td>
<td></td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th colspan=3>downtime</th>
</tr>
</thead>
<tbody>
<tr>
<td>Name</td>
<td>Type</td>
<td>Extra</td>
</tr>
<tr>
<td>id</td>
<td>int</td>
<td>AUTO_INCREMENT PRIMARY KEY</td>
</tr>
<tr>
<td>ip</td>
<td>varchar(255)</td>
<td></td>
</tr>
<tr>
<td>time</td>
<td>datetime</td>
<td></td>
</tr>
<tr>
<td>status</td>
<td>varchar(255)</td>
<td></td>
</tr>
</tbody>
</table>
4. Register new account in app
5. Login
6. Enjoy!
3. Register new account in app
4. Login
5. Enjoy!