Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Installation and First Run

zhiar edited this page May 29, 2026 · 1 revision

Installation & 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.

Prerequisites

  1. Python 3.11 or newer on your PATH.
  2. 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.
  3. At least one memory already filed through MemPalace (otherwise the palace is empty and there's nothing to browse).

Install & run

Option A — run from a clone (no install step)

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_dashboard

Then open http://127.0.0.1:8765 .

Option B — install as a command

If you prefer an isolated, on-PATH install, use pipx (or uv tool install):

pipx install apricity
apricity

Note: the import package is still named mempalace_dashboard (so python -m mempalace_dashboard works); only the distribution, command, and brand are apricity. A legacy mempalace-dashboard command alias is kept for older setups.

Pointing Apricity at your palace

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.

First-run checklist

  1. ✅ MemPalace is installed and you've successfully filed at least one memory through it.
  2. ~/.mempalace/palace/chroma.sqlite3 and ~/.mempalace/knowledge_graph.sqlite3 exist — or you've pointed MEMPALACE_PALACE_DB / MEMPALACE_KG_DB at where they actually live.
  3. MEMPALACE_PYTHON_BIN points at a Python that can import mempalace. Test it:
    $MEMPALACE_PYTHON_BIN -c "import mempalace; print(mempalace.__file__)"
  4. ✅ You opened Apricity, clicked Settings → Account, and set a username + password (see below).

Create your login (do this first)

Apricity ships in open setup mode — until you create credentials, anyone who can reach the port can use it. On first run:

  1. Open http://127.0.0.1:8765 .
  2. Click the Settings gear, then the Account pane.
  3. 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.)

Did it work?

  • 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 .

Clone this wiki locally

AltStyle によって変換されたページ (->オリジナル) /