Installation

This guide covers the installation and setup of EvidentSource for different environments and use cases.

System Requirements

Minimum Requirements

• CPU: 2 cores (x86_64 or ARM64)
• Memory: 4GB RAM
• Storage: 10GB available space
• OS: Linux, macOS, or Windows (via WSL2)

Recommended for Production

• CPU: 4+ cores (ARM64/Graviton preferred for AWS)
• Memory: 16GB+ RAM
• Storage: 100GB+ SSD
• OS: Ubuntu 22.04 LTS or Amazon Linux 2023

Installing Prerequisites

Docker

For containerized deployments:

# Ubuntu/Debian
sudo apt-get update
sudo apt-get install docker.io docker-compose

# macOS
brew install docker docker-compose

# Start Docker service
sudo systemctl start docker  # Linux
# or use Docker Desktop on macOS/Windows

Java (For JVM Client Applications)

Required if you’re building applications using our JVM client libraries:

# Install Java 17+
# Ubuntu/Debian
sudo apt install openjdk-17-jdk

# macOS
brew install openjdk@17

# Verify
java -version

Installation Methods

Method 1: AWS Marketplace

The recommended way to deploy EvidentSource is through AWS Marketplace:

1. Visit the EvidentSource AWS Marketplace listing (coming soon)
2. Subscribe to the product
3. Launch using CloudFormation or ECS

Method 2: Docker Image

Use the official Docker image from our registry:

# Login to EvidentSource registry (credentials provided after purchase)
docker login registry.evidentsource.com

# Pull the image
docker pull registry.evidentsource.com/evidentsource-server:latest

# Run with in-memory storage (development only)
docker run -p 8080:8080 registry.evidentsource.com/evidentsource-server:latest --scheme http in-memory

Method 3: Binary Installation

Download pre-built binaries from your customer portal:

# Download from your customer portal
# https://customers.evidentsource.com/downloads

# Example installation
chmod +x evidentsource-server-linux-x86_64
sudo mv evidentsource-server-linux-x86_64 /usr/local/bin/evidentsource-server

Platform-Specific Instructions

Linux

Ubuntu/Debian

# Install runtime dependencies
sudo apt-get update
sudo apt-get install -y ca-certificates

# Download and install from customer portal
wget https://customers.evidentsource.com/downloads/evidentsource-server-linux-x86_64
chmod +x evidentsource-server-linux-x86_64
sudo mv evidentsource-server-linux-x86_64 /usr/local/bin/evidentsource-server

Red Hat/CentOS/Amazon Linux

# Install runtime dependencies
sudo yum install ca-certificates

# Download and install from customer portal
wget https://customers.evidentsource.com/downloads/evidentsource-server-linux-x86_64
chmod +x evidentsource-server-linux-x86_64
sudo mv evidentsource-server-linux-x86_64 /usr/local/bin/evidentsource-server

macOS

# Download from customer portal
# Run the installer package (.pkg)
# Or use the binary directly:
chmod +x evidentsource-server-darwin-x86_64
sudo mv evidentsource-server-darwin-x86_64 /usr/local/bin/evidentsource-server

Windows

Use Docker Desktop for Windows with our official Docker images:

# Install Docker Desktop
# Then run EvidentSource container
docker run -p 8080:8080 registry.evidentsource.com/evidentsource-server:latest

Or use WSL2 and follow Linux instructions.

Architecture Support

EvidentSource provides pre-built binaries for:

• Linux x86_64: Standard Intel/AMD processors
• Linux ARM64: AWS Graviton and other ARM processors
• macOS x86_64: Intel Macs
• macOS ARM64: Apple Silicon (M1/M2/M3)
• Windows: Via Docker or WSL2

All binaries are optimized for their respective architectures.

Configuration

Environment Variables

# Server configuration
export EVIDENT_DB_PORT=8080
export EVIDENT_DB_HOST=0.0.0.0
export EVIDENT_DB_SCHEME=https

# Storage configuration (DynamoDB)
export AWS_REGION=us-east-1
export AWS_ENDPOINT_URL=http://localhost:4566  # LocalStack

# Logging
export RUST_LOG=evidentsource=debug,tower_http=debug

Configuration File

Create config.toml:

[server]
host = "0.0.0.0"
port = 8080
scheme = "http"

[storage]
adapter = "dynamodb"

[dynamodb]
endpoint_url = "http://localhost:4566"
region = "us-east-1"

Verifying Installation

Check Server Version

evidentsource-server --version

Health Check

Start the server and verify:

# Start server
evidentsource-server --scheme http in-memory

# In another terminal
curl http://localhost:8080/health
# Should return: OK

Verify Installation

After installation, verify EvidentSource is working:

# Check version
evidentsource-server --version

# Run health check (after starting server)
curl http://localhost:8080/health

Client Library Installation

JVM (Maven)

Add to pom.xml:

<dependency>
    <groupId>com.evidentdb</groupId>
    <artifactId>evidentsource-client</artifactId>
    <version>0.1.0</version>
</dependency>

JVM (Gradle)

Add to build.gradle.kts:

dependencies {
    implementation("com.evidentdb:evidentsource-client:0.1.0")
}

Rust Client

Add to Cargo.toml:

[dependencies]
evidentsource-client = "0.1.0"

Systemd Service

Create /etc/systemd/system/evident-source.service:

[Unit]
Description=EvidentSource Server
After=network.target

[Service]
Type=simple
User=evident
ExecStart=/usr/local/bin/evidentsource-server --scheme http dynamodb
Restart=always
RestartSec=10
Environment="RUST_LOG=evidentsource=info"

[Install]
WantedBy=multi-user.target

Enable and start:

sudo systemctl enable evidentsource
sudo systemctl start evidentsource
sudo systemctl status evidentsource

Troubleshooting

Installation Errors

Permission denied:

# Ensure executable permissions
chmod +x evidentsource-server

# Check file ownership
ls -la /usr/local/bin/evidentsource-server

# Fix if needed
sudo chown root:root /usr/local/bin/evidentsource-server

Missing dependencies:

# Linux: Install required libraries
sudo apt-get install ca-certificates libssl1.1

# macOS: Install via Homebrew if needed
brew install openssl

Runtime Errors

Port already in use:

# Find process using port
lsof -i :8080

# Use different port
evidentsource-server --port 8081

Permission denied:

# Check file permissions
ls -la /usr/local/bin/evidentsource-server

# Fix permissions
chmod +x /usr/local/bin/evidentsource-server

Next Steps

• Follow the Quick Start Guide to create your first database
• Learn about Deployment Options for production
• Explore Configuration Options in detail
• Set up Monitoring and Observability