jeffreybbrown/org-roam repository overview

This Docker container runs org-roam⁠ in Emacs⁠.

There are many ways you could run it; here's what I do:

docker run -ti --name roam                              \
  -v /tmp/.X11-unix:/tmp/.X11-unix:ro                   \
  -e DISPLAY="unix$DISPLAY"                             \
  -e UNAME="emacser"                                    \
  -e GNAME="emacsers"                                   \
  -e UID="1000"                                         \
  -e GID="1000"                                         \
  -v /home/jeff/org/roam/mnt-data:/mnt/roam-data        \
  -v /home/jeff/org/roam/mnt-misc:/mnt/misc             \
  jeffreybbrown/org-roam:worked                         \
  bash

The two lines that start with -v /home/jeff/org/roam/mnt- are specific to my computer; they mount two folders on my host system (listed to the left of the colon) to two folders in the Docker container (to the right of the colon). Rather than /home/jeff/org/roam, you'll want to change them to whatever makes sense on your system. The roam-data folder is where your org-roam database will reside. The other one isn't really necessary, but it might be handy for transferring things between the host system and the Docker container, such as your Emacs configuration, without mixing them up with your database, which might be large.

Once it starts, run sudo emacs to launch Emacs. If you ever run into a permission problem, you can hack your way around it with sudo. If you know how to change the Dockerfile to avoid such problems, you're awesome! Please send a pull request to the Github repo for this project⁠.