Repository navigation
Installation
PaperProxy needs Java 25, like current Velocity.
- Newest release: https://github.com/OPaperStream/PaperProxy/releases/latest/download/paperproxy.jar
- All releases: GitHub or Codeberg
Each release has two jars:
| File | What it is |
|---|---|
paperproxy-<version>.jar |
Small jar (about 2 MB). Downloads its libraries into libraries/ on the first start and checks every file against its SHA-256. |
paperproxy-<version>-full.jar |
Everything inside, for servers without internet access. |
.sha512 and .sig let you check the jar. The auto-updater only installs releases with a valid signature.
java -Xms512M -Xmx512M -jar paperproxy.jarThe first start creates velocity.toml, paperproxy.toml, messages.yml and motd.yml. Add your servers to velocity.toml like on Velocity, then restart.
Import pterodactyl/egg-paperproxy.json under Admin, Nests, Import Egg. It installs the latest release or a chosen tag, checks the SHA-512 checksum and can use the -full jar.
Put Velocity and BungeeCord plugins into the same plugins/ folder. Not sure if a plugin works? Use the Plugin Checker.
New versions of plugins can be dropped into plugins/update. On the next start they replace the old jar with the same file name or the same plugin id.
PaperProxy checks GitHub for new versions. With updates.channel = "auto" (the default) you hear about versions of the same stage or newer: on a beta about betas and releases. Staff with paperproxy.update get an in-game notice with buttons. /pp update downloads the update, checks its signature and that the version inside the jar matches the release, and installs it on the next start. Since 1.2.2 this also works on Windows. [auto-update] enabled = true does that on its own.
How releases are signed is described in SECURITY.md.