mirror of https://github.com/Aelita4/sshmon.git
				
				
				
			Add README and LICENSE
This commit is contained in:
		
							parent
							
								
									95b5be4e5b
								
							
						
					
					
						commit
						b5cfa42197
					
				| 
						 | 
				
			
			@ -0,0 +1,21 @@
 | 
			
		|||
MIT License
 | 
			
		||||
 | 
			
		||||
Copyright (c) 2022 Aelita4
 | 
			
		||||
 | 
			
		||||
Permission is hereby granted, free of charge, to any person obtaining a copy
 | 
			
		||||
of this software and associated documentation files (the "Software"), to deal
 | 
			
		||||
in the Software without restriction, including without limitation the rights
 | 
			
		||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 | 
			
		||||
copies of the Software, and to permit persons to whom the Software is
 | 
			
		||||
furnished to do so, subject to the following conditions:
 | 
			
		||||
 | 
			
		||||
The above copyright notice and this permission notice shall be included in all
 | 
			
		||||
copies or substantial portions of the Software.
 | 
			
		||||
 | 
			
		||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 | 
			
		||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 | 
			
		||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 | 
			
		||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 | 
			
		||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 | 
			
		||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 | 
			
		||||
SOFTWARE.
 | 
			
		||||
| 
						 | 
				
			
			@ -0,0 +1,73 @@
 | 
			
		|||
# sshmon
 | 
			
		||||
### Utility to monitor uptime of servers/services
 | 
			
		||||
 | 
			
		||||
## First configuration
 | 
			
		||||
1. Create docker image
 | 
			
		||||
- `$ docker build -t sshmon .`
 | 
			
		||||
 | 
			
		||||
2. Setup containers
 | 
			
		||||
- `$ docker-compose up -d`
 | 
			
		||||
 | 
			
		||||
  - This will open ports 3306 for database, 8080 for main app and 8081 for phpMyAdmin
 | 
			
		||||
 | 
			
		||||
3. Create database and tables
 | 
			
		||||
- Script does not create database and tables by default
 | 
			
		||||
  - Create database `sshmon` with 2 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>
 | 
			
		||||
 | 
			
		||||
4. Register new account in app
 | 
			
		||||
5. Login
 | 
			
		||||
6. Enjoy!
 | 
			
		||||
 | 
			
		||||
		Loading…
	
		Reference in New Issue