Skip to main content
AllCodex is designed to be self-hosted. You can run the entire platform on a home server, a local machine, or a cloud VPS (Virtual Private Server).

​
System Requirements

Before deploying AllCodex, ensure your host environment meets the following specifications:
RequirementRecommendedMinimumNotes
Operating SystemLinux (Ubuntu/Debian)macOS / WindowsDocker runs most stably on native Linux.
CPU2 Cores1 CoreVector search and AI parsing require light compute.
RAM4 GB2 GBHeadless Trilium (Core) caches notes in-memory.
Disk Space10 GB2 GBDependent on map uploads and database size.
API KeysOpenRouter API KeyOpenRouter API KeyRequired by AllKnower for LLM and embeddings.

​
Port Allocations

AllCodex exposes three main web ports. Ensure these ports are open on your host machine and not blocked by local firewalls (like ufw or iptables):
  • 3000 (AllCodex Portal): The main user interface. This is the only port you need to expose to your local network or reverse proxy to access the grimoire.
  • 3001 (AllKnower): The AI backend API. Must be reachable by the Portal server-side, but does not need to be exposed to the public internet.
  • 8080 (AllCodex Core): The lore database and public share server. Must be reachable by the Portal and AllKnower, and optionally exposed if you want players to access shared wikis directly.

​
Data Persistence & Storage Layout

AllCodex persists data in three locations. In our Docker Compose configuration, these are consolidated under the /srv/allcodex/ directory on the host: 
/srv/allcodex/
├── core-data/                # SQLite databases & configurations for Core
│   ├── document-backups/     # Scheduled note backups
│   ├── my-database.db        # The primary SQLite database file
│   └── config.json           # User options and editor themes
│
└── knower-data/              # AllKnower databases
    └── lancedb/              # On-disk Vector embeddings database
Ensure you regularly back up /srv/allcodex. If this folder is deleted, you will lose your entire lore database, system templates, user profiles, and vector indexes.