Skip to main content

Beta Testing

New beta releases are announced on our Discord Server before they are officially published to the Obsidian Community Plugin catalog. Your feedback as a beta tester helps ensure stability for all users!

How to Install Beta Releases​

We recommend using BRAT (Beta Reviewer's Auto-update Tool) to easily manage beta installations.

[!WARNING] Always use a test vault (or a backup copy of your vault) when testing beta releases. Do not run beta software on production data without backups.

Step 1: Install BRAT​

Click here or:

  1. Open Obsidian and go to Settings → Community Plugins.
  2. Click Browse and search for BRAT (Beta Reviewer's Auto-update Tool).
  3. Click Install, then Enable.

Step 2: Add the Plugin to BRAT​

  1. Go to the BRAT settings page in your Obsidian options.
  2. Under Beta Plugin List, click the Add Beta plugin button.
  3. Enter the repository URL: https://github.com/jonjampen/obsidian-xournalpp
  4. Click Add Plugin. BRAT will download the latest beta release and enable it automatically.

Providing Feedback & Reporting Bugs​

If you encounter any issues, bugs, or have suggestions:

  1. GitHub Issues: Open a bug report or feature request on our GitHub Issues page using our structured issue forms.
  2. Discord: Join the Discord Server and chat in the #beta-testing channel. You can request the @Beta Tester role in #welcome to get notifications when new test builds are released.

Thank you for helping test and improve the plugin!