Org-roam Protocol

about | blog | config | notes | github

1. Org-roam Protocol: Browser Integration for Roam

The purpose of the org-roam-protocol extension is to provide ways of interacting with your Org-roam files from your browser.

2. Configuration

2.1. Package Setup

Make sure we have Org-roam all setup first before we enable the org-roam-protocol.

(require 'init-org-roam)

Setup org-roam-protocol.

(require 'org-roam-protocol)

Make sure to provide it as well.

(provide 'init-org-roam-protocol)

2.2. Desktop Entry

In order for the protocol to work properly, we need to create a desktop entry for GNU/Emacs (connecting to our daemon) and associate the org-protocol:// type links with the application using XDG Utils.

[Desktop Entry]
Name=Org-Protocol
Exec=emacsclient --socket-name=xorg-emacs-daemon %u
Icon=emacs-icon
Type=Application
Terminal=false
MimeType=x-scheme-handler/org-protocol

This command will register the defaut application (which we defined above) for org-roam-protocol.

xdg-mime default org-protocol.desktop x-scheme-handler/org-protocol

Created: 2021-11-13

Emacs 26.1 (Org mode 9.5)