selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

GitLab

Self-host memEx

Zettelkasten-style notes, contexts and pipelines

BetaOpen Sourceagpl-3.0
Docker ComposeFull install guide
docker run -it shibaobun/memex /app/priv/random.sh
Updated3 weeks ago
Setup difficultyModerate
Port
4000 (Internal port the app binds to; must be reverse proxied)
Requires
PostgreSQL
Docker
shibaobun/memex
memEx home page

What is memEx?

memEx is a personal knowledge-base web app whose structure follows Zettelkasten thinking and org-mode habits. Users capture three kinds of things: Notes for individual concepts or items, Contexts that frame one topic and hotlink into those notes, and Pipelines that spell out a process step by step, each step tied to a context. Other capabilities include multi-user accounts designed around sharing, privacy settings that apply per note, context or pipeline, backlinks listing which items point at the one you are reading, and access from any browser-connected device. Operators run it by copying the project's example compose file, filling in environment variables, generating a cookie-signing secret and a cloak key with helper scripts inside the published container image, then bringing the stack up; a reverse proxy in front of the app is required, and PostgreSQL stores the data. Mail delivery is configured through SMTP variables, or switched off entirely. Whoever registers first becomes administrator, and sign-ups are invite-only unless public registration is enabled. The code is AGPLv3-or-later and hosted on GitLab, where it is still an early-stage project.

memEx alternatives

Should you self-host memEx?

memEx scores 48/100 on selfhost.directory (how scoring works) and ranks #22 of 42 in Knowledge Management.

There was no stable release in the past 12 months, so check the repository's recent activity before you rely on it.

Setup is moderate: expect some configuration beyond a single command. An official Docker image is available. It is agpl-3.0-licensed.

Its closest alternative on selfhost.directory is Project N.O.M.A.D. (86/100, 43 694 stars). It scores higher overall, so compare the two before you pick. See memEx vs Project N.O.M.A.D. side by side.

Features

  • Backlinks
  • Contexts with hotlinks
  • Email notifications via SMTP
  • Invite-only registration
  • Multi-user collaboration
  • Notes
  • Per-item privacy controls
  • Process pipelines

How to install memEx

Install memEx with Docker Compose

Environment variables
HOST, PORT, DATABASE_URL, SECRET_KEY_BASE, CLOAK_KEY, REGISTRATION, LOCALE, DISABLE_EMAIL, SMTP_HOST, SMTP_PORT, SMTP_USERNAME, SMTP_PASSWORD, SMTP_SSL, EMAIL_FROM, EMAIL_NAME, POOL_SIZE, ECTO_IPV6
  1. Install Docker Compose or alternatively Docker Desktop on your machine.
  2. Copy the example docker-compose.yml. into your local machine where you want. Bind mounts are created in the same directory by default.
  3. Set the configuration variables in docker-compose.yml. You'll need to run docker run -it shibaobun/memex /app/priv/random.sh to generate a new secret key base. Generate a CLOAK_KEY with docker run --rm shibaobun/memex /app/priv/cloak_key.sh.
  4. Use docker-compose up or docker-compose up -d to start the container!

The app must be placed behind a reverse proxy; PostgreSQL is required.

How to configure memEx

  • HOSTExternal URL used to generate links; must be your hosted domain name
  • PORT4000Internal port to bind to; must be reverse proxied
  • DATABASE_URLecto://postgres:postgres@memex-db/memexDatabase URL to connect to
  • ECTO_IPV6falseIf true, Ecto uses IPv6 to connect to PostgreSQL

    values: true, false

  • POOL_SIZE10Connection pool size used with PostgreSQL

More in Knowledge Management

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…