-
-
Notifications
You must be signed in to change notification settings - Fork 0
Installation and First Run
Apricity itself has zero runtime dependencies — it's one file of standard-library Python plus static assets. The only real prerequisite is a working MemPalace install on the same machine.
-
Python 3.11 or newer on your
PATH. -
A working MemPalace install with its own virtual-env. Apricity reads the MemPalace SQLite/Chroma files directly, but writes by shelling out to a Python that can
import mempalace. So that interpreter must exist and be importable. - At least one memory already filed through MemPalace (otherwise the palace is empty and there's nothing to browse).
The whole server is standard-library Python, so the simplest path is straight from a checkout:
git clone https://github.com/epinethrone/apricity
cd apricity
python3 server.py # identical to: python -m mempalace_dashboardThen open http://127.0.0.1:8765.
If you prefer an isolated, on-PATH install, use pipx (or uv tool install):
pipx install apricity
apricityNote: the import package is still named
mempalace_dashboard(sopython -m mempalace_dashboardworks); only the distribution, command, and brand areapricity. A legacymempalace-dashboardcommand alias is kept for older setups.
By default Apricity assumes the standard MemPalace home at ~/.mempalace. If your install lives elsewhere, set environment variables before launching (copy .env.example to .env, or export them in your shell). The most important one is:
| Variable | What it must point at |
|---|---|
MEMPALACE_PYTHON_BIN |
a Python that can import mempalace (used for every write) |
MEMPALACE_PALACE_DB |
the Chroma SQLite file with your drawer content |
MEMPALACE_KG_DB |
the knowledge-graph SQLite database |
See the full list on the Configuration page.
- ✅ MemPalace is installed and you've successfully filed at least one memory through it.
- ✅
~/.mempalace/palace/chroma.sqlite3and~/.mempalace/knowledge_graph.sqlite3exist — or you've pointedMEMPALACE_PALACE_DB/MEMPALACE_KG_DBat where they actually live. - ✅
MEMPALACE_PYTHON_BINpoints at a Python that canimport mempalace. Test it:$MEMPALACE_PYTHON_BIN -c "import mempalace; print(mempalace.__file__)"
- ✅ You opened Apricity, clicked Settings → Account, and set a username + password (see below).
Apricity ships in open setup mode — until you create credentials, anyone who can reach the port can use it. On first run:
- Open http://127.0.0.1:8765.
- Click the Settings gear, then the Account pane.
- Set a username and password (≥ 8 characters) and save.
From that point on, Apricity requires sign-in and refuses every other client until they authenticate. Credentials are hashed with PBKDF2-HMAC-SHA256 and never leave the host. (More in Security & Safety.)
- The top bar shows the Apricity logo and a search box.
- The header counters show non-zero Memories / Wings / Rooms / Facts.
- If everything reads
0, jump to Troubleshooting & FAQ.
Next: Tour of the Interface.
Getting started
Using Apricity
- Browsing & Searching
- Writing & Editing
- Deleting & Recovering
- Knowledge Graph & Tunnels
- Notifications
Make it yours
Reference
Repo · MIT