Documentation
Install, run and use Orlok.
Getting started
Introduction
What Orlok is, how it is organized and the words used throughout the documentation.
Requirements
What you need before installing Orlok.
Installation
Configure the settings and start Orlok with Docker Compose.
HTTPS and reverse proxy
Put Orlok behind a reverse proxy with TLS, as production installations should be.
First-run setup
Create the company and the first administrator.
Environment variables
Every setting of the Docker package, which ones you must fill in and which ones compose sets for you.
Security hardening
The container settings the installation package applies, and why to keep them.
Workspace
Sign in and devices
Accept the invitation, sign in and manage the devices you are signed in on.
Your virtual colleagues
Create your own colleagues, choose their profile, archive or delete them.
Conversations
Talk with a colleague, follow its answers and the commands it ran.
Approvals and plans
Decide the commands your colleagues ask to run, one at a time or as a plan.
Approved command types
What "Always allow" approves, and how to review the types you approved.
Notifications and phone app
Email and push notifications, and Orlok installed on your phone.
Language and themes
The languages Orlok speaks, the language colleagues answer in, and the ten colour themes.
Office wiki
The office wiki
The shared memory of an office: who reads it, who writes it, what it is for.
How colleagues use the wiki
What a colleague reads before answering, and how it changes pages safely.
Links and search
Wiki links, search made for IT work, and synonyms.
Page status
Current, superseded, retired or historical: outdated knowledge is marked, never deleted.
Knowledge graph
Related pages and the interactive map of what the office knows.
Review
Contradictions, gaps and outdated pages, and how to work through them.
Proposals from conversations
Durable knowledge proposed from your conversations, seen only by you.
Importing documents
File office documents and scans into the wiki.
Importing notes
Bring Markdown notes from Obsidian, Notion or Joplin, without their passwords.
Operations
How operations work
How a colleague goes from a question to a command on a server, and who decides along the way.
Hosts
The one registry of the machines colleagues can reach.
Credentials
Your own accounts on the hosts, and how colleagues use them.
SSH and PowerShell
How the runner connects to Linux and Windows hosts, and how to prepare them.
Modes and what runs without asking
The four modes of a colleague profile, which commands run at once, which ones ask, and which ones are always refused.
MCP servers
Tools for every colleague of an office, and the ready-made catalog.
Audit and installation log
What is logged, and where to read it.
Administration
Models
Model providers, embeddings and the model that reads images.
Colleague profiles
The model and mode colleagues work with, and who may use them.
Email
The SMTP server for invitations and notifications.
Offices
Create offices, and empty an office wiki to import it again.
People and invitations
Invite people, set their roles, offices and profiles, and disable access.