added a TODO to README.md
This commit is contained in:
parent
53dc0beb08
commit
e65fec386b
1 changed files with 9 additions and 8 deletions
17
README.md
17
README.md
|
|
@ -32,7 +32,7 @@ Edit config.json to your needs.
|
||||||
- uplinks: List of devices you want to poll
|
- uplinks: List of devices you want to poll
|
||||||
- provider: Custom name of the uplink provider
|
- provider: Custom name of the uplink provider
|
||||||
- ip: The IP of the router device
|
- ip: The IP of the router device
|
||||||
- password: The password of the router device
|
- password: The password of the router device
|
||||||
|
|
||||||
#### Example
|
#### Example
|
||||||
|
|
||||||
|
|
@ -45,7 +45,7 @@ Edit config.json to your needs.
|
||||||
{ "provider": "DSL Provider", "ip": "192.168.1.1", "password": "1234" }
|
{ "provider": "DSL Provider", "ip": "192.168.1.1", "password": "1234" }
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
||||||
### Create Database
|
### Create Database
|
||||||
|
|
||||||
sqlite3 uplink.sqlite3 < uplink.sql
|
sqlite3 uplink.sqlite3 < uplink.sql
|
||||||
|
|
@ -53,27 +53,28 @@ Edit config.json to your needs.
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
./uplink ./config.json
|
./uplink ./config.json
|
||||||
|
|
||||||
### Help
|
### Help
|
||||||
|
|
||||||
./uplink --help
|
./uplink --help
|
||||||
|
|
||||||
## View collected data
|
## View collected data
|
||||||
|
|
||||||
I actually use "[DB Browser for SQLite](https://sqlitebrowser.org/)" for taking a look at the
|
I actually use "[DB Browser for SQLite](https://sqlitebrowser.org/)" for taking a look at the
|
||||||
data uplink is collecting.
|
data uplink is collecting.
|
||||||
|
|
||||||
There will be a Gtk+ frontend to uplink at some time but this project is at a very early
|
There will be a Gtk+ frontend to uplink at some time but this project is at a very early
|
||||||
stage of development, so I want to write the collector first. Even support for other SQL
|
stage of development, so I want to write the collector first. Even support for other SQL
|
||||||
databases is in planning in conjunction with the Gtk+ frontend. I use sqlite3 only because I
|
databases is in planning in conjunction with the Gtk+ frontend. I use sqlite3 only because I
|
||||||
can move fast-forward.
|
can move fast-forward.
|
||||||
|
|
||||||
## TODO
|
## TODO
|
||||||
|
|
||||||
- A lot... :)
|
- A lot... :)
|
||||||
|
- Parallelize queries using threads to improve performance
|
||||||
- SQL server backend
|
- SQL server backend
|
||||||
- Gtk+ frontend
|
- Gtk+ frontend
|
||||||
- ~~A cron mode to not let uplink run in an endless loop to be scheduled and executed by cron.~~
|
- ~~A cron mode to not let uplink run in an endless loop to be scheduled and executed by cron.~~
|
||||||
- A daemon mode to be a real UNIX daemon. For now, it's just "sleep" based.
|
- A daemon mode to be a real UNIX daemon. For now, it's just "sleep" based.
|
||||||
- Platform independence
|
- Platform independence
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue