41 lines
1.0 KiB
Markdown
41 lines
1.0 KiB
Markdown
# SPRKLstats
|
|
|
|
Statistics for motd on Spoorkuil VM
|
|
|
|
## Installation
|
|
|
|
1. Clone repo via https/ssh
|
|
```
|
|
https://git.dehosting.club/stefanw/SPRKLstats.git
|
|
```
|
|
|
|
2. Run init.py with escalated privileges
|
|
```
|
|
sudo python3 init.py
|
|
```
|
|
|
|
3. Check if works correctly by running
|
|
```
|
|
run-parts /etc/update-motd > /dev/null
|
|
```
|
|
|
|
## Usage
|
|
### Configuration
|
|
All configuration is done in `config.py`
|
|
|
|
#### Adding mounting points
|
|
In order to add extra mounting points to be displayed in SPRKLstats, you have to edit the mountpoints variable.
|
|
In the env class, there is a variable named mountpoints, simply add another entry into the list as a string.
|
|
|
|
#### Adding services
|
|
In order to add extra services to be displayed by SPRKLstats, you have to edit the services variable. This is a python dictionary, therefore there is specific syntax. A new entry is of the following syntax:
|
|
```python
|
|
'service name': 'Display Name'
|
|
```
|
|
Make sure entries are seperated with a comma.
|
|
|
|
#### Changing the text art
|
|
Simply change the name variable in the env class.
|
|
|
|
|