Installation Guide
Get ScoutQuest up and running in your environment with these installation options.
Quick Start
The fastest way to get started with ScoutQuest is using Docker. This method requires no additional dependencies and gets you running in seconds.
# Run ScoutQuest server with Docker
docker run -p 8080:8080 scoutquest/server
# Server will be available at http://localhost:8080Installation Methods
Docker Installation
Docker is the recommended way to run ScoutQuest in production. It provides isolation, easy deployment, and consistent behavior across environments.
Using Docker Run
# Basic run
docker run -p 8080:8080 scoutquest/server
# With persistent configuration
docker run -p 8080:8080 -v $(pwd)/config:/app/config scoutquest/server
# With custom port
docker run -p 3000:8080 scoutquest/serverUsing Docker Compose
version: '3.8'
services:
scoutquest:
image: scoutquest/server:latest
ports:
- "8080:8080"
volumes:
- ./config:/app/config
- scoutquest_data:/app/data
environment:
- RUST_LOG=info
restart: unless-stopped
volumes:
scoutquest_data:Binary Download
Download pre-compiled binaries for your platform from GitHub releases. This method provides native performance without container overhead.
Download Latest Release
# Linux x86_64
curl -L -o scoutquest-server \
https://github.com/RomainDECOSTER/scoutquest/releases/latest/download/scoutquest-server-linux-x86_64
# macOS Intel
curl -L -o scoutquest-server \
https://github.com/RomainDECOSTER/scoutquest/releases/latest/download/scoutquest-server-macos-intel
# macOS Apple Silicon
curl -L -o scoutquest-server \
https://github.com/RomainDECOSTER/scoutquest/releases/latest/download/scoutquest-server-macos-arm64
# Windows
curl -L -o scoutquest-server.exe \
https://github.com/RomainDECOSTER/scoutquest/releases/latest/download/scoutquest-server-windows.exeMake Executable and Run
# Make executable (Linux/macOS)
chmod +x scoutquest-server
# Run the server
./scoutquest-server
# Optional: Move to PATH
sudo mv scoutquest-server /usr/local/bin/Cargo Install
Install directly from crates.io using Rust's package manager. This method compiles from source and requires Rust to be installed.
Prerequisites
# Install Rust (if not already installed)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/envInstall ScoutQuest
# Install latest version
cargo install scoutquest-server
# Install specific version
cargo install scoutquest-server --version 1.0.0
# Install from git (latest development)
cargo install --git https://github.com/RomainDECOSTER/scoutquest scoutquest-serverRun
# Run from anywhere (installed in ~/.cargo/bin)
scoutquest-serverFrom Source
Build ScoutQuest from source code. This method gives you the latest features and allows for customization.
Prerequisites
- Rust 1.75.0 or later
- Git
- OpenSSL development libraries (Linux)
# Install system dependencies
# Ubuntu/Debian
sudo apt update
sudo apt install build-essential libssl-dev pkg-config
# RHEL/CentOS/Fedora
sudo yum install gcc openssl-devel pkgconfig
# or
sudo dnf install gcc openssl-devel pkgconfig
# macOS (using Homebrew)
brew install openssl pkg-configClone and Build
# Clone the repository
git clone https://github.com/RomainDECOSTER/scoutquest.git
cd scoutquest
# Build in release mode
cargo build --release --bin scoutquest-server
# Run the server
./target/release/scoutquest-server
# Optional: Install globally
cargo install --path scoutquest-serverVerification
After installation, verify that ScoutQuest is running correctly:
# Check if server is running
curl http://localhost:8080/health
# Expected response:
# {"status":"healthy","timestamp":"2025-01-XX...","version":"1.0.0"}You can also visit http://localhost:8080 in your browser to see the
ScoutQuest dashboard.