ian/org-roam-ui-docker
Watch
1
0
Fork
You've already forked org-roam-ui-docker
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Containerized org-roam-ui environment for hosting your roam wiki
14 commits 1 branch 0 tags 16 KiB
  • Emacs Lisp 56.2%
  • Shell 24.2%
  • Dockerfile 19.6%
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Ian Keane 8909d25746 working prototype
2024-02-10 00:12:34 +00:00
.gitignore initial commit 2023-12-15 16:22:56 -05:00
docker-compose.yml working prototype 2024-02-10 00:12:34 +00:00
Dockerfile working prototype 2024-02-10 00:12:34 +00:00
entrypoint.sh working prototype 2024-02-10 00:12:34 +00:00
init.el working prototype 2024-02-10 00:12:34 +00:00
README.md working prototype 2024-02-10 00:12:34 +00:00

README.md

Required environment variables

ROAM_WIKI_REPO

  • A link to a repo containing your org-roam-directory

HOSTED_ENDPOINT

  • The endpoint where your site is hosted, without http://
    • This will be used for the server websocket connection

ORG_ROAM_UI_PORT

  • A port for the UI frontend

ORG_ROAM_UI_WEBSOCKET_PORT

  • Used internally by org-roam-ui

Usage

This should work if you run docker-compose up from the main directory. It will also use ORG_ROAM_UI_PORT as a websocket port. Visit localhost:$ORG_ROAM_UI_PORT in a web browser to see the org-roam-ui interface. The $ORG_ROAM_UI_WEBSOCKET_PORT is used internally by org roam, and provided in case there is a conflict.