Executable

Coming Soon

Any present tense information in this section is not accurate. Once a release is made, the following information will apply shortly thereafter.

On GitHub, Stump has pre-built binaries, for both the Stump server and desktop application, for Linux, macOS, and Windows platforms.

Downloading the Stump desktop application

If you want to install the desktop application, you will want to select the appropriate binary for your operating system:

  • macOS: Stump.dmg
  • Linux: Stump.AppImage
  • Windows: Stump.exe

Downloading the Stump server

Otherwise, for the Stump server, follow the instructions below for your operating system to install Stump.

Linux

Coming Soon!

TODO: write systemd tutorial TODO: init scripts for alpine/non-systemd? (https://wiki.alpinelinux.org/wiki/Writing_Init_Scripts) TODO: look into freebsd

macOS

Coming Soon!

TODO: research the following:

  • https://www.karltarvas.com/2020/09/11/macos-run-script-on-startup.html
  • https://medium.com/@fahimhossain_16989/adding-startup-scripts-to-launch-daemon-on-mac-os-x-sierra-10-12-6-7e0318c74de1

Windows

Note

I am currently exploring solutions for Windows systems to be able to configure Stump as an auto-startup service. For now, you will need to manually run the executable from the command line.

Coming Soon!

TODO: research the following (I don't use windows so):

  • https://github.com/mullvad/windows-service-rs
  • http://nssm.cc/usage

Example Windows service file provided by @KrautByte:

[Unit]
Description=Stump Book Server
After=network.target
StartLimitIntervalSec=0
[Service]
Type=simple
Restart=always
RestartSec=1
User=stump
WorkingDirectory=/opt/stump
ExecStart=pnpm start core

[Install]
WantedBy=multi-user.target