azurejelly/standalone-nuvotifier repository overview

⁠azure's NuVotifier fork

A NuVotifier fork with Redis forwarding support and a standalone server implementation. From the original README:

⁠Useful resources

• Setup Guide⁠
• Troubleshooting Guide⁠
• Developer Information⁠

⁠Running

You can get the latest release directly from GitHub by clicking here⁠. Then, follow the instructions for your server software or for the standalone version.

⁠Bukkit, BungeeCord and Velocity

Drag and drop the downloaded JAR into your plugins/ folder. You should've downloaded the JAR that has your server software in its name. If you've done everything right, it should work out of the box.

⁠Standalone

Open up the terminal, go into the directory the previously downloaded JAR is at, and then run it like this:

$ java -Xms512M -Xmx512M -jar nuvotifier-standalone.jar

You can also use command line arguments to configure some settings, such as the hostname:

$ java -Xms512M -Xmx512M -jar nuvotifier-standalone.jar --host 127.0.0.1 --config /etc/nuvotifier/

To get a full list of options, run:

$ java -jar nuvotifier-standalone.jar --help

⁠Standalone with Docker

A Docker image is available at Docker Hub⁠. To pull it, run:

$ docker pull azurejelly/standalone-nuvotifier:latest

You can run the image using a command like:

$ docker run -p 8192:8192 \
    -v /etc/nuvotifier:/app/config \
    --restart unless-stopped \
    --name nuvotifier \
    azurejelly/standalone-nuvotifier:latest
    --port 8192

This will:

• Expose port 8192 on the host machine;
• Map /etc/nuvotifier (host) to /app/config (container) using bind mounts;
• Restart the container automatically unless stopped;
• Name the container nuvotifier;
• Use the azurejelly/standalone-nuvotifier:latest image;
• And pass --port 8192 as a command line argument to NuVotifier.

Additionally, if you're also running your Minecraft server with Docker, you could create a network for cross-container communication (though do note that you will need to recreate your existing containers in order to do this):

$ docker network create votifierNetwork
$ docker run ... --network votifierNetwork ...

If you want to use Docker Compose, an example docker-compose.yml⁠ file is available on the repository.

⁠License

NuVotifier is GNU GPLv3 licensed. This project's license can be viewed here⁠.