https://gitea.bubbletea.dev/shibao/memex

This website requires JavaScript.
Logo
Explore Help
Register Sign In
shibao/memEx
 
Watch 1
Star 1
Fork 0
You've already forked memEx
Code Issues 1 Pull Requests Projects Releases 21 Wiki Activity
351 Commits 3 Branches 21 Tags
 Go to file
Code
Clone
HTTPS
[https://gitea.bubbletea.dev/sh]
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
# shibao 926d4f9837
All checks were successful
continuous-integration/drone/tag Build is passing
Details
continuous-integration/drone/push Build is passing
Details
fix style
2025-04-05 04:02:14 +00:00
assets
fix style
2025-04-05 04:02:14 +00:00
config
fix style
2025-04-05 04:02:14 +00:00
lib
fix style
2025-04-05 04:02:14 +00:00
priv
update deps
2025-04-05 03:42:43 +00:00
test
update deps
2025-04-05 03:42:43 +00:00
.credo.exs
use credo style
2023-02-04 17:36:27 -05:00
.drone.yml
update deps
2025-04-05 03:42:43 +00:00
.formatter.exs
upgrade to phoenix 1.7
2023-04-13 23:29:29 -04:00
.gitignore
update deps
2025-04-05 03:42:43 +00:00
.tool-versions
update deps
2025-04-05 03:42:43 +00:00
changelog.md
update deps
2025-04-05 03:42:43 +00:00
contributing.md
fix broken install step
2025-02-13 22:01:54 +00:00
de.tbx
Added translation using Weblate (German)
2025-04-05 03:42:51 +00:00
docker-compose.yml
fix broken docker-compose
2022-12-19 21:09:50 -05:00
Dockerfile
update deps
2025-04-05 03:42:43 +00:00
home.png
add backlinks
2025-02-15 06:01:03 +00:00
license.md
add missing license, whoops!!
2024-12-31 00:32:20 -05:00
mix.exs
update deps
2025-04-05 03:42:43 +00:00
mix.lock
update deps
2025-04-05 03:42:43 +00:00
readme.md
add backlinks
2025-02-15 06:01:03 +00:00

readme.md

memEx

home page screenshot

A structured personal knowledge base, inspired by zettlekasten and
org-mode.

  * 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
  * Backlinks: View referencing items from the referenced item

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 priv/random.sh 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".

Contribution

Contributions are greatly appreciated, no ability to code needed! You
can browse the Contribution Guide to learn more.

I can be contacted at shibao@bubbletea.dev, or on the fediverse at
@shibao@misskey.bubbletea.dev. Thank you!

License

memEx is licensed under AGPLv3 or later. A copy of the latest version
of the license can be found at license.md.

Links

  * Gitea: Main repo, feature requests and bug reports
  * Github: Source code mirror, please don't open pull requests to
    this repository
  * Weblate: Contribute to translations!

---------------------------------------------------------------------

BuildStatus translationstatus

[          ]
Description
A structured personal knowledge base, inspired by zettlekasten and
org-mode
Readme 11 MiB
Languages
Elixir 81.2%
HTML 16.4%
CSS 1.2%
JavaScript 0.9%
Dockerfile 0.3%
Powered by Gitea Version: 1.23.6 Page: 85ms Template: 4ms
English
Bahasa Indonesia Deutsch English Espanol Francais Gaeilge Italiano 
Latviesu Magyar nyelv Nederlands Polski Portugues de Portugal 
Portugues do Brasil Suomi Svenska Turkce Cestina Ellenika B'lgarski 
Russkii Ukrayins'ka frsy mlyaallN Ri Ben Yu Jian Ti Zhong Wen Fan Ti Zhong Wen (Tai Wan )Fan Ti Zhong Wen 
(Xiang Gang ) hangugeo
Licenses API