setup.md

Self-hosting instructions!

As ProxyFox is privacy-focused, giving instructions on setting up your own instance is a must

1. Prerequisites

1a. Java Development Kit

ProxyFox runs on top of Java 17, so you need to install the proper JDK, we recommend Adoptium OpenJDK

1b. MongoDB (Optional, but recommended)

For the most compatible database implementation, it's recommended to install MongoDB

1c. Environment Variables

ProxyFox requires an environment variable set, called PROXYFOX_KEY, that contains the token for the bot.

More information can be found at https://dis.gs/docs and the developer portal. Make sure to enable Message Content Intents in the dashboard.

2. Building

ProxyFox uses a Gradle build system. You can follow the building instructions for your platform

2a. Windows (Command Prompt)

gradlew build

2b. Windows (PowerShell), Linux (Bash, Shell), Mac (Terminal)

./gradlew build

2c. Intellij IDEA

Run the build Gradle task

3 Running ProxyFox

Take the proxyfox.jar (name may vary, but will have proxyfox in it somewhere), found in modules/bot/build/libs put it into a separate folder, and run the following command (Replace proxyfox.jar with the name of the file)

java -jar proxyfox.jar

Additional Notes

• If you encounter any problems with any of the steps, join our discord server and open a support thread.