HOME/DOCS/INSTALLATION

Installation

Installation options and requirements for sendword.

Sendword ships as a crates.io binary crate, prebuilt release artifacts, a Docker image, and source code.

Cargo

cargo install sendword

Release installers

Linux x86_64:

curl --proto '=https' --tlsv1.2 -LsSf https://releases.sendword.online/latest/sendword-installer.sh | sh

Windows PowerShell:

powershell -ExecutionPolicy Bypass -c "irm https://releases.sendword.online/latest/sendword-installer.ps1 | iex"

Both installers default to the latest release and install into $HOME/.cargo/bin. Put that directory on your PATH before starting sendword.

The installers default to latest. To pin a release, set SENDWORD_VERSION to a version tag:

curl --proto '=https' --tlsv1.2 -LsSf https://releases.sendword.online/latest/sendword-installer.sh | SENDWORD_VERSION=v0.8.7 sh

In PowerShell:

$env:SENDWORD_VERSION = "v0.8.7"
powershell -ExecutionPolicy Bypass -c "irm https://releases.sendword.online/latest/sendword-installer.ps1 | iex"

Override the install directory with SENDWORD_INSTALL_DIR.

Docker

The official image is published to GitHub Container Registry:

docker pull ghcr.io/wavefunk/sendword:latest

Run with a mounted data directory:

mkdir -p data
docker run --rm -p 8080:8080 -v "$PWD/data:/data" ghcr.io/wavefunk/sendword:latest

Persistent files are written under /data. The image includes Node.js and Python for webhook scripts that run inside the container.

Manual artifacts

Release archives and checksums are published under latest/:

  • https://releases.sendword.online/latest/sendword-x86_64-unknown-linux-gnu.tar.gz
  • https://releases.sendword.online/latest/sendword-x86_64-pc-windows-gnu.zip
  • https://releases.sendword.online/latest/SHA256SUMS

Replace latest with a version tag such as v0.8.7 to download a specific release.

From source

git clone https://github.com/wavefunk/sendword
cd sendword
cargo build --release

The binary will be at target/release/sendword.

Development shell

If you use Nix and direnv, the repository dev shell provides the pinned Rust toolchain and local build dependencies:

direnv allow

Requirements

  • Linux x86_64 or Windows x86_64 for prebuilt release installers
  • Docker for the container image
  • Rust nightly nightly-2026-01-05 for building from source
  • A directory with write access for the database and logs