Thanks for your interest in the project - it is mostly for personal use but if anyone else finds it useful, that's great.
If you're looking to contribute, see here
If you find a bug, please raise an issue or pull request and I'll take a look.
By default this is intended to be run with docker, there's a compose file available and this should set everything up.
- git clone
- docker-compose up -d
- This creates a default config file for you, config.yml in a docker volume named config
- The admin details will be output to docker logs
If you're doing this yourself, you will need the following:
- JVM (Tested on 12)
- Gradle (Tested on 5)
- MySQL (Tested 8)
Setting | Default | Comments |
---|---|---|
dbhost | ig | Defaults to database, unless using included docker-compose. |
db | ig | Must be created first, unless using included docker-compose. |
dbuser | ig | |
dbpassword | ig | |
dbport | 3306 | |
sessionKey | [Random String] | Value used to encrypt sessions. |
adminUsername | admin | Default admin username |
adminPassword | [Random String] | Default admin password |
webPort | 80 | Default port to listen on for web connections |
refreshDelay | 15 | Total delay between polls |
igLogin | false | Should we log in to poll |
igUsername | Login username | |
igPassword | Login password |
You can adjust the logging by creating a file called log.properties in the config folder, this file is a standard JDK logging properties file and can be used to edit the logging as desired. To enable debug logging for instance, use the below
java.util.logging.SimpleFormatter.format=[%1$tF %1$tT] [%4$-7s]: %5$s%6$s%n
handlers=java.util.logging.ConsoleHandler
.level=FINEST
A restart will be required for the changes to take effect.