Setup - njb-said/Godfrey GitHub Wiki

Setup Guide: Requirements

To setup Godfrey you will need a few things

• Basic linux/command line knowledge
• A working Redis server (Official Documentation)
• Java 7 or later installed (How-to: CentOS/Fedora via yum, Ubuntu via apt-get)
• You agree by using this software to this disclaimer.

Setup Guide: Getting the jar file

Visit the releases page and download the latest version of Godfrey.jar.
This can be done (for v1.0) using the following command:
wget https://github.com/njb-said/Godfrey/releases/download/1.0/Godfrey.jar
or upload it to your server into a directory you wish.

Setup Guide: Running the jar

To run the jar you will need Java as stated above, you will also need a working Redis server.
If you need either of these things please follow the guides above.

If your redis server has no auth use this command:
java -jar Godfrey.jar redis.yourserver.com yourredisport
Replace redis.yourserver.com with the IP or hostname of your redis server and yourredisport with the port your redis server is running on. The default is 6379

If your redis server has auth enabled use this command:
java -jar Godfrey.jar redis.yourserver.com yourredisport abcdef
Replace redis.yourserver.com with the IP or hostname of your redis server and yourredisport with the port your redis server is running on. The default is 6379. Replace abcdef with the auth key for your redis server.

Setup Guide: Finishing up

That's all there is to installing Godfrey on one of your servers. After this you can start sending commands via the web ui (coming soon) or directly using the command request packet.