Example Configuration - TheBloom46/bloommanager-wiki GitHub Wiki

An example BloomManager configuration using Velocity as the proxy and PaperSpigot backend servers.

Downloads

As plugin jars can't be included by default, please download the following proxy plugins:

Verify that Docker is installed and running as guided here

This "easier" option does not show the Docker image-building process. Since this setup doesn't allow you to modify the files on the example Docker images, the Restart Script feature isn't natively supported.

Unzip the files of option 1 into its own folder.

Drag and drop the downloaded plugin jars from above into the velocity/plugins directory.

  • Input your redis database credentials into the RedisBungee and BloomManager configuration.

Load the Docker images onto the node using docker load --input <file>

  • ex. docker load --input queue.tar

Verify the Docker images (hub and queue for option 1) are loaded with docker images

Start the velocity by running start.sh in the velocity directory.

Test the configuration in the methods mentioned here

  • An example usage of /servers create with option 1 would be /servers create queue 2000 queues

This option shows you an example of building the Docker images, also allowing you to enable the Restart Script functionality.

Unzip the files of option 2 into its own folder.

Please enter the root directory of the unzipped folder.

If you want to use the restart script feature on the example queue and hub:

  • Open queuerestartscript/BloomManagerRestartScript and enter your redis details to match the BloomManager configuration on the proxy.
  • Do the same for hubrestartscript
  • Add the RestartScript.jar to hubrestartscript and queuerestartscript

Dockerfile is what is responsible for constructing the Docker image

  • In the file provided, edit the line COPY hub /home to match the folder you'd like to construct the image with such as COPY hubrestartscript /home
  • After editing the Dockerfile, go to the root directory of the unzipped file (where you can see the Dockerfile and the desired server folder) and run docker build -t <imageName>:latest ., ex. docker build -t hubrestartscript:latest .
  • Do the same for queuerestartscript
  • Learn more about Dockerfiles here

If you're building this Docker image outside of the dedicated server (such as on your PC), please read below:


Export your Docker images with the command docker save -o <filename> <imageName>:<release>

  • ex. docker save -o hubrestartscript.tar hubrestartscript:latest

Upload this file to the node on which the proxy is running and import this image with docker load --input <filename>, ex docker load --input hubrestartscript.tar


Follow the rest of the instructions in "Option 1." In this scenario, replace queue with queuerestartscript and hub with hubrestartscript.

⚠️ **GitHub.com Fallback** ⚠️