Stump Docs

Download the source code

You can download the source code for Stump from the GitHub repository. You can either clone the repository using Git or download it as a ZIP file and extract it.

If you want the latest release, the main branch is the best option. Commits are usually only made to main through the release pipeline. You may also want to check out the nightly branch, where you can get access to some of the more cutting edge features that are still in development.

Any other branch is likely to be unstable and not recommended for installation.

Install dependencies

The contributing guide provides detailed instructions on installing the necessary dependencies for building Stump from source. Please follow those instructions to set up your development environment.

Build Stump locally

Afterwards, you can run the following command to build Stump locally:

yarn web build && cargo build --package stump_server --release

This will bundle the web application and build the Stump server. The server binary is located at target/release/stump_server, and the web bundle at apps/web/dist. You can place those two items anywhere you'd like, just be sure they are either next to each other or you have set the appropriate environment variable.

Enable PDF support

PDF rendering relies on PDFium. Unlike the Docker image, a source build does not include the PDFium binary, so you must download it yourself and tell Stump where it is. Without this, opening a PDF fails with a PdfConfigurationError.

Download the PDFium binary for your platform from bblanchon/pdfium-binaries. Each release archive contains the shared library under lib/:
- macOS: libpdfium.dylib
- Linux: libpdfium.so
- Windows: pdfium.dll
Point Stump at the binary via the PDFIUM_PATH environment variable (or the pdfium_path key in your Stump.toml):
```
export PDFIUM_PATH="/absolute/path/to/libpdfium.dylib"
```

PDFIUM_PATH must be the full path to the library file itself, not the directory containing it. See the server configuration reference for more details.

Community packages

The packages listed here are maintained by community members, not the Stump developer. Use them at your own discretion and please report any packaging issues to the respective maintainers

Arch Linux (AUR)

An AUR package is available for Arch-based Linux distributions. It compiles Stump from source and installs a systemd service for you. You can install it using your preferred AUR helper:

yay -S stump

Source