Installation Guide

Choose the installation method that suits you to quickly deploy Shortlinker.

Requirements

Runtime Environment

• Operating System: Linux, macOS, Windows
• Network Connection: Required for downloading dependencies

Source Compilation Environment

• Rust: >= 1.85.0 (required, Edition 2024)
• Git: For cloning the project

Installation Methods

🐳 Docker Deployment (Recommended)

No dependencies required, start with one command:

# Basic run
docker run -d -p 8080:8080 e1saps/shortlinker

# Data persistence (recommended)
docker run -d -p 8080:8080 -v $(pwd)/data:/data e1saps/shortlinker

📦 Pre-compiled Binaries

Download the pre-compiled version for your platform:

# Linux x64
wget https://github.com/AptS-1547/shortlinker/releases/latest/download/shortlinker-linux-x64.tar.gz
tar -xzf shortlinker-linux-x64.tar.gz
./shortlinker

# macOS
wget https://github.com/AptS-1547/shortlinker/releases/latest/download/shortlinker-macos.tar.gz

# Windows
# Download shortlinker-windows.zip and extract

🔧 Source Compilation

Suitable for users who need customization:

# 1. Install Rust (if not already installed)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env

# 2. Check version
rustc --version  # Should be >= 1.85.0

# 3. Clone and compile
git clone https://github.com/AptS-1547/shortlinker.git
cd shortlinker

# Basic compilation (server only)
cargo build --release

# Compile with TUI interface
cargo build --release --features tui

# Full compilation (server + CLI + TUI)
cargo build --release --features full

# 4. Run
./target/release/shortlinker

Quick Verification

After installation, verify the service is working properly:

# Start service
./shortlinker

# Test in another terminal
curl -I http://localhost:8080/
# Should return 307 redirect

Common Issues

Rust Version Too Old

# Update to latest version
rustup update

Compilation Failed

# Clean and rebuild
cargo clean && cargo build --release

Port Already in Use

# Use a different port
SERVER_PORT=3000 ./shortlinker

Next Steps

After installation, continue reading:

• 🚀 Quick Start - Learn basic usage
• ⚙️ Configuration - Understand configuration options
• 📋 CLI Tools - Master command line operations