a structured, zettlekasten and org-mode inspired memex
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
shibao df44be2b1b
continuous-integration/drone/push Build is passing Details
improve logger
2 days ago
assets improve ci 4 days ago
config fix tests 4 days ago
lib improve logger 2 days ago
priv improve invites, record usage 4 days ago
test use credo style 4 days ago
.credo.exs use credo style 4 days ago
.drone.yml improve ci 4 days ago
.formatter.exs update deps 3 months ago
.gitignore rename to memex 3 months ago
.tool-versions improve ci 4 days ago
Dockerfile attempt to fix libcrypto error 2 months ago
changelog.md improve oban logging 4 days ago
contributing.md fix some typos 2 months ago
de.tbx Added translation using Weblate (German) 2 months ago
docker-compose.yml fix broken docker-compose 2 months ago
home.png add screenshot 2 months ago
mix.exs fix bug with public registration 5 days ago
mix.lock add qr code for invite link 2 weeks ago
readme.md fix some typos 2 months ago



old screenshot

memEx is an easy way to digitize the structured processes of your life.

  • Notes: Document notes about individual items or concepts
  • Contexts: Provide context around a single topic and hotlink to individual concepts in your notes
  • Pipelines: Document your processes, attaching contexts to each step.


  • Multi-user: Built with sharing and collaboration in mind
  • Privacy: Privacy controls on a per-note, context or pipeline basis
  • Convenient: Accessible from any internet-capable device


  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.
  4. Use docker-compose up or docker-compose up -d to start the container!

The first created user will be created as an admin.


You can use the following environment variables to configure memEx in docker-compose.yml.

  • HOST: External url to generate links with. Must be set with your hosted domain name! I.e. memex.mywebsite.tld
  • PORT: Internal port to bind to. Defaults to 4000. Must be reverse proxied!
  • DATABASE_URL: Controls the database url to connect to. Defaults to ecto://postgres:postgres@memex-db/memex.
  • ECTO_IPV6: If set to true, Ecto should use ipv6 to connect to PostgreSQL. Defaults to false.
  • POOL_SIZE: Controls the pool size to use with PostgreSQL. Defaults to 10.
  • SECRET_KEY_BASE: Secret key base used to sign cookies. Must be generated with docker run -it shibaobun/memex mix phx.gen.secret and set for server to start.
  • REGISTRATION: Controls if user sign-up should be invite only or set to public. Set to public to enable public registration. Defaults to invite.
  • LOCALE: Sets a custom default locale. Defaults to en_US.
  • SMTP_HOST: The url for your SMTP email provider. Must be set
  • SMTP_PORT: The port for your SMTP relay. Defaults to 587.
  • SMTP_USERNAME: The username for your SMTP relay. Must be set!
  • SMTP_PASSWORD: The password for your SMTP relay. Must be set!
  • SMTP_SSL: Set to true to enable SSL for emails. Defaults to false.
  • EMAIL_FROM: Sets the sender email in sent emails. Defaults to no-reply@HOST where HOST was previously defined.
  • EMAIL_NAME: Sets the sender name in sent emails. Defaults to "memEx".

BuildStatus translationstatus