Browse Source

Updated readme with configuration and running instructions

master
Zack Marvel 1 year ago
parent
commit
f55b515a9f
1 changed files with 31 additions and 0 deletions
  1. +31
    -0
      README.md

+ 31
- 0
README.md View File

@@ -6,12 +6,43 @@ need package upgrades. It uses the [asyncssh][asyncssh] library to establish
an SSH connection to a list of systems, and the [Flask][flask] framework for
the web interface.


## Usage

apt-monitor should be provided with a list of systems to monitor, as well as an
SSH key associated with each system. It can be configured to poll each system
after a particular interval has elapsed.


### Configuration

apt-monitor looks for `apt-monitor.ini` in the project root (the same folder as
the `src` directory) by default. Here's an example:

```
[apt-monitor]
interval=60

[DEFAULTS]
IdentityFile=~/.ssh/id_rsa
User=zack

[system1]

[system2]
IdentityFile=~/.ssh/id_rsa_other
```

### Running

The project can be run from the project root with
```
$ FLASK_APP=src/web.py flask run
```

It can be stopped with Ctrl-C.


## Considerations

- apt-monitor queries each system at a regular interval, and stores the list of


Loading…
Cancel
Save