Skip to content

installation.md

Latest commit

 

History

History
111 lines (78 loc) · 2.36 KB

installation.md

File metadata and controls

111 lines (78 loc) · 2.36 KB
Raw

Installation

This guide covers the different ways to install Egide.

Requirements

  • Operating System: Linux (recommended), macOS, or Windows
  • Architecture: x86_64 (AMD64)
  • Memory: Minimum 128 MB, recommended 512 MB
  • Disk: Minimum 100 MB for binaries

Docker (Recommended)

The easiest way to run Egide is using Docker:

docker run -d \
  --name egide \
  -p 8200:8200 \
  -v egide-data:/var/lib/egide \
  nubster/egide:latest

The published image is a release build. It always starts sealed and refuses dev mode by design: initialize and unseal it with the CLI or the REST API (see the Quick Start).

Docker Compose

Create a docker-compose.yml:

services:
  egide:
    image: nubster/egide:latest
    ports:
      - "8200:8200"
    volumes:
      - egide-data:/var/lib/egide
    environment:
      - EGIDE_DATA_DIR=/var/lib/egide
    restart: unless-stopped

volumes:
  egide-data:

Then run:

docker compose up -d

Binary Installation

Download

Download the latest release from GitHub Releases:

# Linux (AMD64)
curl -LO https://github.com/nubster-opensources/egide/releases/latest/download/egide-linux-amd64.tar.gz
tar xzf egide-linux-amd64.tar.gz
sudo mv egide egide-server /usr/local/bin/

Verify Installation

egide --version
egide-server --version

Build from Source

Prerequisites

  • Rust 1.79 or later
  • Git

Build

git clone https://github.com/nubster-opensources/egide.git
cd egide
cargo build --release

Binaries will be available in target/release/:

  • egide-server: the server binary
  • egide: the CLI tool

Install

sudo cp target/release/egide-server /usr/local/bin/
sudo cp target/release/egide /usr/local/bin/

Development Mode

For local development against a debug build (not the published Docker image, which is always a release build), dev mode auto-unseals with the master key stored in cleartext. It requires an explicit opt-in and is refused entirely in release builds:

EGIDE_UNSAFE_DEV_MODE=1 cargo run -p egide-server -- --dev

Never set EGIDE_UNSAFE_DEV_MODE outside local development.

Next Steps