Skip to main content

​
Prerequisites

Before installing, make sure you have:
  • A running Open Notes server reachable from your Discourse host (see headers and auth for network requirements).
  • A service-account-level API key from the Open Notes server. The plugin sends this key on every request as X-API-Key.
  • Discourse admin access and the ability to rebuild the container.

​
Installation

1

Edit app.yml

Open your Discourse app.yml (usually at /var/discourse/containers/app.yml) and add the plugin clone hook inside the after_code section:
hooks:
  after_code:
    - exec:
        cd: $home/plugins
        cmd:
          - git clone https://github.com/opennotes-ai/opennotes.git opennotes-discourse
If you already have other plugins, add this entry to the existing cmd list — do not create a second after_code block.
2

Rebuild the container

From your Discourse server:
./launcher rebuild app
This pulls the plugin source and bakes it into the container image. Rebuilds typically take 5–10 minutes.
3

Verify the plugin loaded

After the rebuild, log in as an admin and navigate to Admin > Plugins. You should see discourse-opennotes in the plugin list.If the plugin does not appear, check the container logs for load errors:
./launcher logs app | grep opennotes
4

Configure the plugin

The plugin is installed but not yet active. Proceed to the Configure page to connect it to your Open Notes server.