Skip to main content
Version: 1.1

Installation

Installation Methods​

Choose the installation method that best fits your environment.

Binary Installation​

Download​

  1. Visit the GitHub Releases page
  2. Download the latest release for your platform:
    • secan-linux-amd64 for Linux (x86_64)
    • secan-linux-arm64 for Linux (ARM64)
    • secan-macos-amd64 for macOS (Intel)
    • secan-macos-arm64 for macOS (Apple Silicon)
    • secan-windows-amd64.exe for Windows

Extract and Run​

# Linux/macOS
tar -xzf secan-linux-amd64.tar.gz
cd secan
cp config.example.yaml config.yaml

# Edit config.yaml with your Elasticsearch cluster details
./secan

# Windows
# Extract the ZIP file and open the folder
# Copy config.example.yaml to config.yaml
# Edit config.yaml with your cluster details
# Run secan.exe

Access the UI​

Open your browser and navigate to:

http://localhost:27182

Docker Installation​

Pull and Run​

# Pull from GitHub Container Registry
docker pull ghcr.io/wasilak/secan:latest

# Run Secan
docker run -d \
  --name secan \
  -p 27182:27182 \
  ghcr.io/wasilak/secan:latest

Access Secan at http://localhost:27182

With Configuration File​

docker run -d \
  --name secan \
  -p 27182:27182 \
  -v $(pwd)/config.yaml:/app/config.yaml \
  ghcr.io/wasilak/secan:latest

Docker Compose​

Create docker-compose.yml:


services:
  secan:
    image: ghcr.io/wasilak/secan:latest
    ports:
      - "27182:27182"
    volumes:
      - ./config.yaml:/app/config.yaml:ro
    restart: unless-stopped

Create config.yaml:

server:
  host: "0.0.0.0"
  port: 27182

auth:
  mode: open
  session_timeout_minutes: 60

clusters:
  - id: "local"
    name: "Local Elasticsearch"
    nodes:
      - "$\{ES_URL\}"
    auth:
      type: "basic"
      username: "$\{ES_USERNAME\}"
      password: "$\{ES_PASSWORD\}"
    es_version: 8

Then run with environment variables:

export ES_URL="http://elasticsearch:9200"
export ES_USERNAME="elastic"
export ES_PASSWORD="your-password"
docker-compose up -d

Building from Source​

Prerequisites​

  • Rust 1.75 or newer
  • Node.js 18 or newer
  • npm or yarn

Build Steps​

# Clone the repository
git clone https://github.com/wasilak/secan.git
cd secan

# Build frontend
cd frontend
npm install
npm run build
cd ..

# Build backend (includes embedded frontend)
cargo build --release

# Run
./target/release/secan

The compiled binary will be at target/release/secan (or secan.exe on Windows).

Next Steps​

  1. Read the Configuration guide to set up authentication and clusters
  2. Learn about Features and what you can do with Secan
  3. Check out Cluster Details to understand the interface