Skip to main content

Installation & Setup

This guide covers installing the official CLI, adding the TypeScript driver to your application, and running the Lioran S3 server.

1. CLI Installation​

The official command-line interface is packaged on npm as @liorans3/cli.

Requirements​

  • Node.js: >= 18.0.0
  • npm, pnpm, or yarn

Global Installation​

# Install globally via npm (pre-alpha dist-tag)
npm install -g @liorans3/cli@prealpha

Or install with yarn/pnpm:

# pnpm
pnpm add -g @liorans3/cli@prealpha

# yarn
yarn global add @liorans3/cli@prealpha

Verify CLI Installation​

Verify the CLI binary (liorans3) is available on your system path:

liorans3 --version

Expected output:

0.1.0-prealpha.2

2. TypeScript / JavaScript Driver Installation​

The official SDK driver is packaged on npm as @liorans3/driver.

Requirements​

  • Node.js: >= 18.0.0 (Native undici and fetch support included)
  • TypeScript: >= 5.0 (Optional, for type-checked projects)

Install in Your Project​

# npm
npm install @liorans3/driver

# pnpm
pnpm add @liorans3/driver

# yarn
yarn add @liorans3/driver

Driver Package Details​

  • Package Name: @liorans3/driver
  • Current Version: 0.1.0-prealpha.1
  • Module Format: ECMAScript Modules (ESM) with dual declaration files (dist/index.d.ts).

3. Running the Server​

Run Lioran S3 alongside the Caddy reverse proxy with automatic HTTPS and persistent volumes:

# Clone the repository
git clone https://github.com/LioranGroupOfficial/LioranBastion-Rust.git
cd LioranBastion-Rust

# Copy production environment configuration
cp .env.production.example .env

# Edit .env and configure your domain & strong admin password
# BASTION_DOMAIN=s3.yourdomain.com
# BASTION_ADMIN_PASSWORD=YourStrongPasswordHere123!
# BASTION_SIGNING_SECRET=$(openssl rand -hex 32)

# Start the stack
docker compose up -d

Verify the server is running:

curl -f http://localhost:27118/health
# Or via Caddy HTTPS:
# curl -f https://s3.yourdomain.com/health

Expected response:

{
  "name": "Lioran Bastion",
  "status": "ok",
  "version": "0.1.0"
}

Option B: Native Cargo Build​

To build and run the server directly from source:

Prerequisites​

  • Rust Toolchain: 1.75+ (stable)
  • C++ Build Tools: Required by embedded RocksDB (build-essential, clang, or MSVC on Windows)
  • FFmpeg: (Optional) Required only if utilizing the experimental video transcoding subsystem

Compilation​

# Clone and enter workspace
git clone https://github.com/LioranGroupOfficial/LioranBastion-Rust.git
cd LioranBastion-Rust

# Compile release binaries
cargo build --release --bin bastion-server --bin bastion

Running the Server​

# Development mode (binds 127.0.0.1:27118 with default admin credentials)
./target/release/bastion-server

Server startup log output:

2026-10-01T12:00:00.000Z  INFO bastion_server: Starting Lioran Bastion storage engine (v0.1.0)
2026-10-01T12:00:00.002Z  INFO bastion_server: Initialized metadata store (RocksDB) at ./data/metadata
2026-10-01T12:00:00.005Z  INFO bastion_server: Durability mode: strict (fsync per write)
2026-10-01T12:00:00.010Z  INFO bastion_server: Bound HTTP listener to 127.0.0.1:27118