shibao/memEx
1
1
Fork 0
Code Issues 5 Pull Requests Projects Releases 16 Wiki Activity
a structured, zettlekasten and org-mode inspired memex
160 Commits 2 Branches 16 Tags 8.9 MiB
Elixir 80.5%
HTML 16.6%
JavaScript 1.6%
SCSS 1%
Dockerfile 0.3%
311579efd6
Go to file
shibao 311579efd6
Some checks failed
continuous-integration/drone/push Build is failing
Details
improve oban logging
2023-02-04 20:48:17 -05:00
assets fix webpack 2023-01-25 21:20:53 -05:00
config improve oban logging 2023-02-04 20:48:17 -05:00
lib improve oban logging 2023-02-04 20:48:17 -05:00
priv improve invites, record usage 2023-02-04 17:22:06 -05:00
test use credo style 2023-02-04 17:36:27 -05:00
.credo.exs use credo style 2023-02-04 17:36:27 -05:00
.drone.yml update drone 2022-11-27 01:18:04 -05:00
.formatter.exs update deps 2022-11-03 18:23:17 -04:00
.gitignore rename to memex 2022-11-03 18:23:17 -04:00
.tool-versions update versions 2022-11-03 18:23:17 -04:00
changelog.md improve oban logging 2023-02-04 20:48:17 -05:00
contributing.md fix some typos 2022-11-27 21:23:27 -05:00
de.tbx Added translation using Weblate (German) 2022-12-20 03:35:57 +00:00
docker-compose.yml fix broken docker-compose 2022-12-19 21:09:50 -05:00
Dockerfile attempt to fix libcrypto error 2022-11-27 11:49:17 -05:00
home.png add screenshot 2022-11-26 23:24:23 -05:00
mix.exs fix bug with public registration 2023-02-04 10:31:59 -05:00
mix.lock add qr code for invite link 2023-01-26 00:46:27 -05:00
readme.md fix some typos 2022-11-27 21:23:27 -05:00

readme.md

memEx

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.

Features

  • 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

Installation

  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.

Configuration

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

Build Status translation status