[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8},"actionData","errors","docs-layout-en",{"_37":38},"doc-en",{"_9":10,"_11":12,"_13":14,"_15":16,"_17":18,"_19":20,"_21":22,"_23":24,"_25":26,"_27":28},"slug","requirements","title","Requirements","description","What you need before installing Orlok.","group","start","order",2,"html","

Orlok is in early access: the installation package is shared on request. It contains the Docker\nCompose file, the example settings and the sources that the images are built from.

A server with Docker and Docker Compose.
Access to at least one model provider (Anthropic, OpenAI, an OpenAI-compatible server or Ollama).
An SMTP server, to send invitations and notifications by email (optional but recommended).

","headings",[],"translated",true,"previous",{"_9":33,"_11":34,"_13":35,"_15":16,"_17":36},"next",{"_9":29,"_11":30,"_13":31,"_15":16,"_17":32},"installation","Installation","Configure the settings and start Orlok with Docker Compose.",3,"introduction","Introduction","What Orlok is, how it is organized and the words used throughout the documentation.",1,"groups",[39,40,41,42,43,44,45],{"_15":16,"_47":203},{"_15":173,"_47":174},{"_15":134,"_47":135},{"_15":103,"_47":104},{"_15":80,"_47":81},{"_15":61,"_47":62},{"_15":46,"_47":48},"reference","docs",[49,50,51],{"_9":58,"_11":59,"_13":60,"_15":46,"_17":36},{"_9":55,"_11":56,"_13":57,"_15":46,"_17":18},{"_9":52,"_11":53,"_13":54,"_15":46,"_17":32},"glossary","Glossary","The words Orlok uses, in one place.","security-model","Security model","What Orlok protects, how, and what it leaves to you.","roles-and-permissions","Roles and permissions","What administrators, office managers and members can do, and what stays private to each person.","maintenance",[63,64,65,66],{"_9":77,"_11":78,"_13":79,"_15":61,"_17":36},{"_9":74,"_11":75,"_13":76,"_15":61,"_17":18},{"_9":71,"_11":72,"_13":73,"_15":61,"_17":32},{"_9":67,"_11":68,"_13":69,"_15":61,"_17":70},"troubleshooting","Troubleshooting","Common problems with installation, sign-in, colleagues and operations, and how to fix them.",4,"restore","Restore","Restore a backup on the same or a new server.","backup","Backup","What to back up and how to take a consistent backup.","upgrade","Upgrade","Move an installation to a new Orlok version safely.","administration",[82,83,84,85,86],{"_9":100,"_11":101,"_13":102,"_15":80,"_17":36},{"_9":97,"_11":98,"_13":99,"_15":80,"_17":18},{"_9":94,"_11":95,"_13":96,"_15":80,"_17":32},{"_9":91,"_11":92,"_13":93,"_15":80,"_17":70},{"_9":87,"_11":88,"_13":89,"_15":80,"_17":90},"people","People and invitations","Invite people, set their roles, offices and profiles, and disable access.",5,"offices","Offices","Create offices, and empty an office wiki to import it again.","email","Email","The SMTP server for invitations and notifications.","colleague-profiles","Colleague profiles","The model and mode colleagues work with, and who may use them.","models","Models","Model providers, embeddings and the model that reads images.","operations",[105,106,107,108,109,110,111],{"_9":103,"_11":132,"_13":133,"_15":103,"_17":36},{"_9":129,"_11":130,"_13":131,"_15":103,"_17":18},{"_9":126,"_11":127,"_13":128,"_15":103,"_17":32},{"_9":123,"_11":124,"_13":125,"_15":103,"_17":70},{"_9":120,"_11":121,"_13":122,"_15":103,"_17":90},{"_9":116,"_11":117,"_13":118,"_15":103,"_17":119},{"_9":112,"_11":113,"_13":114,"_15":103,"_17":115},"audit","Audit and installation log","What is logged, and where to read it.",7,"mcp-servers","MCP servers","Tools for every colleague of an office, and the ready-made catalog.",6,"profile-modes","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.","ssh-and-powershell","SSH and PowerShell","How the runner connects to Linux and Windows hosts, and how to prepare them.","credentials","Credentials","Your own accounts on the hosts, and how colleagues use them.","hosts","Hosts","The one registry of the machines colleagues can reach.","How operations work","How a colleague goes from a question to a command on a server, and who decides along the way.","wiki",[136,137,138,139,140,141,142,143,144],{"_9":134,"_11":171,"_13":172,"_15":134,"_17":36},{"_9":168,"_11":169,"_13":170,"_15":134,"_17":18},{"_9":165,"_11":166,"_13":167,"_15":134,"_17":32},{"_9":162,"_11":163,"_13":164,"_15":134,"_17":70},{"_9":159,"_11":160,"_13":161,"_15":134,"_17":90},{"_9":156,"_11":157,"_13":158,"_15":134,"_17":119},{"_9":153,"_11":154,"_13":155,"_15":134,"_17":115},{"_9":149,"_11":150,"_13":151,"_15":134,"_17":152},{"_9":145,"_11":146,"_13":147,"_15":134,"_17":148},"wiki-import-notes","Importing notes","Bring Markdown notes from Obsidian, Notion or Joplin, without their passwords.",9,"wiki-import-documents","Importing documents","File office documents and scans into the wiki.",8,"wiki-proposals","Proposals from conversations","Durable knowledge proposed from your conversations, seen only by you.","wiki-review","Review","Contradictions, gaps and outdated pages, and how to work through them.","wiki-graph","Knowledge graph","Related pages and the interactive map of what the office knows.","wiki-status","Page status","Current, superseded, retired or historical: outdated knowledge is marked, never deleted.","wiki-links-and-search","Links and search","Wiki links, search made for IT work, and synonyms.","wiki-how-colleagues-use-it","How colleagues use the wiki","What a colleague reads before answering, and how it changes pages safely.","The office wiki","The shared memory of an office: who reads it, who writes it, what it is for.","workspace",[175,176,177,178,179,180,181],{"_9":200,"_11":201,"_13":202,"_15":173,"_17":36},{"_9":197,"_11":198,"_13":199,"_15":173,"_17":18},{"_9":194,"_11":195,"_13":196,"_15":173,"_17":32},{"_9":191,"_11":192,"_13":193,"_15":173,"_17":70},{"_9":188,"_11":189,"_13":190,"_15":173,"_17":90},{"_9":185,"_11":186,"_13":187,"_15":173,"_17":119},{"_9":182,"_11":183,"_13":184,"_15":173,"_17":115},"language-and-themes","Language and themes","The languages Orlok speaks, the language colleagues answer in, and the ten colour themes.","notifications","Notifications and phone app","Email and push notifications, and Orlok installed on your phone.","approved-command-types","Approved command types","What \"Always allow\" approves, and how to review the types you approved.","approvals","Approvals and plans","Decide the commands your colleagues ask to run, one at a time or as a plan.","conversations","Conversations","Talk with a colleague, follow its answers and the commands it ran.","colleagues","Your virtual colleagues","Create your own colleagues, choose their profile, archive or delete them.","sign-in","Sign in and devices","Accept the invitation, sign in and manage the devices you are signed in on.",[204,205,206,207,208,209,210],{"_9":33,"_11":34,"_13":35,"_15":16,"_17":36},{"_9":10,"_11":12,"_13":14,"_15":16,"_17":18},{"_9":29,"_11":30,"_13":31,"_15":16,"_17":32},{"_9":220,"_11":221,"_13":222,"_15":16,"_17":70},{"_9":217,"_11":218,"_13":219,"_15":16,"_17":90},{"_9":214,"_11":215,"_13":216,"_15":16,"_17":119},{"_9":211,"_11":212,"_13":213,"_15":16,"_17":115},"security-hardening","Security hardening","The container settings the installation package applies, and why to keep them.","environment-variables","Environment variables","Every setting of the Docker package, which ones you must fill in and which ones compose sets for you.","first-run","First-run setup","Create the company and the first administrator.","https","HTTPS and reverse proxy","Put Orlok behind a reverse proxy with TLS, as production installations should be."]