Run your instance with confidence.

Documentation

Everything you need to install, configure, and operate Arciin on hardware you own — quick answers here, full guides on docs.arciin.com.

Open full documentation →

Install Arciin

One-line install

$ curl -fsSL https://get.arciin.com/install.sh | bash

Browse by topic

Start where you are.

Short summaries on this page. Each topic links to the full guide on docs.arciin.com.

Getting started

Install, claim your instance, and upload your first files in under five minutes.

Quick start
First login
Default libraries

Read full guide →

Installation & storage

Native install, Docker Compose, storage roots, bind mounts, and disk layout.

One-line install
Docker
Storage paths

Read full guide →

Libraries & uploads

Drag-and-drop anywhere, auto-classification, folders, and import from links.

Global uploads
Classification
Folders

Read full guide →

AI & models

Connect providers, chat with files, vision analysis, and model routing on your instance.

Provider keys
Ask AI
Vision

Read full guide →

API & integrations

Scoped API keys, webhooks, Socket.IO events, and automation from your stack.

API keys
REST API
Events

Read full guide →

Mobile PWA

Pair the companion app with a six-digit code and browse libraries on your network.

Install PWA
Pairing
Uploads

Read full guide →

Security & roles

Owner, Admin, Member, Viewer roles, sessions, vault, and hardening your instance.

Roles
Sessions
Password vault

Read full guide →

Operations

Updates, logs, worker jobs, health checks, and keeping Arciin running smoothly.

Updates
Jobs queue
Logs

Read full guide →

Quick start

The 60-second version.

Install

Run the one-line installer on Debian, Ubuntu, WSL, or use Docker Compose on any Linux host.

→

Claim

Open the local URL, paste your ARCIIN_SETUP_TOKEN, name the instance, and create the owner account.

→

Configure

Choose a storage root, confirm default libraries, and set your public URL when you want remote access.

→

Use

Drop files anywhere, pair mobile, connect AI models, and invite users with the right roles.

→

Popular guides

What people read first.

Reference

Environment variables

DATABASE_URL, REDIS_URL, ARCIIN_DATA_DIR, SESSION_SECRET, and every variable your instance expects.

Read on docs.arciin.com →

Install

Docker Compose deployment

Run web, api, worker, PostgreSQL, and Redis with bind-mounted storage at /data/arciin.

Read on docs.arciin.com →

Connect OpenAI, Anthropic, or Ollama

Add provider keys on the Models page. Keys stay on your server — never sent to Arciin cloud.

Read on docs.arciin.com →

Libraries

Global drag-and-drop uploads

Drop files anywhere in the authenticated app. Arciin classifies and routes them to the right library.

Read on docs.arciin.com →

API

API keys & scopes

Issue scoped keys for assets, libraries, uploads, activity, and admin automation.

Read on docs.arciin.com →

Security

Reverse proxy & remote access

Arciin runs on your LAN first. Add a domain, TLS, or tunnel only when you want access from outside.

Read on docs.arciin.com →

FAQ

Common questions.

Tap a question for a short answer. Need the full write-up? Each one links to the complete doc.

On disk at your configured storage root — default /srv/arciin-storage/arciin on native installs, or a bind mount in Docker. PostgreSQL stores metadata only.

Full answer on docs.arciin.com →

Full documentation

Go deeper on docs.arciin.com

API reference, deployment recipes, troubleshooting, and every configuration option — maintained separately so this page stays fast and scannable.

Open docs.arciin.com →View source on GitHub