Installation & Setup
This guide covers installing the official CLI, adding the TypeScript SDK driver to your project, and running the Lioran S3 server via Docker.
1. CLI Installation
The official command-line interface is distributed via 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 installed and available in your shell:
liorans3 --version
Expected output:
0.1.0-prealpha.2
2. TypeScript Driver Installation
The official SDK driver is distributed via npm as @liorans3/driver.
Requirements
- Node.js:
>= 18.0.0(nativefetchsupport included) or Bun - 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 TypeScript declaration files (
dist/index.d.ts).
3. Running the Server
Lioran S3 is distributed as a pre-built Docker container image (liorans3/liorans3:pre-alpha). No source code cloning or Rust compilation toolchain is required to deploy and run the server.
Option A: Docker Single Command (Instant Start)
Launch the Lioran S3 server directly with a single Docker command:
docker run -d \
--name bastion-server \
-p 27118:27118 \
-v $(pwd)/data:/data \
-e BASTION_ENV=production \
-e BASTION_ADMIN_USERNAME=admin \
-e BASTION_ADMIN_PASSWORD=YourStrongPasswordHere123! \
-e BASTION_DURABILITY=strict \
liorans3/liorans3:pre-alpha
:::tip Windows PowerShell Users
In PowerShell, use ${PWD} or an absolute path for the volume mount:
docker run -d `
--name bastion-server `
-p 27118:27118 `
-v ${PWD}/data:/data `
-e BASTION_ENV=production `
-e BASTION_ADMIN_USERNAME=admin `
-e BASTION_ADMIN_PASSWORD=YourStrongPasswordHere123! `
-e BASTION_DURABILITY=strict `
liorans3/liorans3:pre-alpha
:::
Option B: Docker Compose (Recommended for Stacks)
Create a docker-compose.yml file in any working directory:
services:
bastion:
image: liorans3/liorans3:pre-alpha
container_name: bastion-server
restart: unless-stopped
ports:
- "27118:27118"
environment:
- BASTION_ENV=production
- BASTION_HOST=0.0.0.0
- BASTION_PORT=27118
- BASTION_DATA_DIR=/data
- BASTION_ADMIN_USERNAME=admin
- BASTION_ADMIN_PASSWORD=YourStrongPasswordHere123!
- BASTION_DURABILITY=strict
volumes:
- bastion-data:/data
volumes:
bastion-data:
driver: local
Start the container in detached mode:
docker compose up -d
4. Verifying Server Health
Verify the server is running and responding to health check probes:
curl -f http://localhost:27118/health
Or verify using the installed CLI:
liorans3 ping --endpoint http://127.0.0.1:27118
Expected response:
{
"name": "Lioran Bastion",
"status": "ok",
"version": "0.1.0"
}
Next Steps
- Follow the 5-Minute Quickstart to create your first bucket and upload files.
- Learn about Authentication & Keys to generate programmatic API tokens.
- Review the Docker & Caddy Production Guide for automated Let's Encrypt TLS setup.