Venora v0.1.0 · in development

Install

Install from source.

Venora isn't in any browser extension store yet. You load it into a Chromium-based desktop browser in developer mode, straight from the repository. There is no build step and nothing else to install.

  • No store release yet
  • Unpacked extension · no .crx
  • Updates are manual

A Chromium desktop browser

Google Chrome, or another Chromium-based desktop browser that can load unpacked extensions. Venora's automated browser tests run in Chromium (Microsoft Edge).

The Fermo web client

Venora works only on the hosted Fermo client at fermo.sbar.fyi. Plugins run on its /channels/ pages.

Not supported yet

Firefox, Safari, mobile browsers, Fermo's desktop app, self-hosted Fermo instances and other Spacebar clients.

01 Install Venora

Six steps

  1. Get the code

    Clone the repository, or download it as a ZIP and unzip it somewhere you'll keep it. The browser loads Venora from that folder, so don't delete it afterwards.

    Terminal
    $ git clone https://github.com/VenoraProject/Venora.git

    The repository also references Fermo's source as a git submodule, for reference only. You don't need it to run Venora.

  2. Open the extensions page

    Type chrome://extensions into the address bar. In Microsoft Edge, it's edge://extensions.

  3. Turn on Developer mode

    Switch on Developer mode on the extensions page. This lets the browser load an extension from a folder.

  4. Load the venora-chrome folder

    Click Load unpacked and select the venora-chrome/ folder inside the repository, not the repository itself. Venora appears in the list as version 0.1.0.

  5. Open Fermo

    Open or reload fermo.sbar.fyi and go to a channel. A short notice says Venora is running. Plugins are enabled.

  6. Find the Plugins page

    Open Fermo's settings and choose Plugins. That's where you add, configure and remove plugins.

Pin the Venora toolbar button. It's your way back if a plugin ever makes Fermo hard to use. Open your browser's extensions menu and pin Venora. Its menu can turn on safe mode, and disable or uninstall any plugin, without going through Fermo's page.

02 Add a plugin

Install a plugin from a ZIP

  1. Get the plugin's ZIP from someone you trust. There is no plugin registry yet, so plugins are shared as files.

  2. In Fermo, open Settings → Plugins and choose Add plugin, then pick the ZIP.

  3. Venora checks the whole package before saving anything. If the plugin declares a sensitive permission (network or account), you'll be asked to confirm it.

  4. The page reloads and the plugin starts on channel pages. Its card shows its state, for example Running in sandbox.

Want to see the sandbox at work? The repository includes examples/hello-runtime/. Compress that folder into a ZIP and add it. With the developer console open on a channel page, it logs that the network, the page and extension APIs are all blocked.

03 Updates

Keeping things up to date

Updating Venora

Extensions loaded in developer mode don't update themselves. Pull the latest code, or download it again into the same folder, then click Reload on Venora in the extensions page and reload Fermo.

Terminal · in the repository
$ git pull

Updating a plugin

Choose Add plugin and pick a newer ZIP of the same plugin. Venora shows the installed and new versions with the new release notes, and replaces the plugin only if you choose Update. Its settings and data are kept.

04 Troubleshooting

If something isn't right

There's no Plugins page in Fermo's settings.
Check that you're on fermo.sbar.fyi, which is the only site Venora runs on, and that Venora is enabled in the extensions page. Then reload Fermo.
A plugin made Fermo hard to use.
Click the Venora button in the browser toolbar and turn on safe mode. It stops every imported plugin straight away. Then disable or uninstall the culprit from the same menu.
A plugin card says “Failed to run” or “Not compatible”.
The card shows the reason. Other plugins keep running. A failed plugin is tried again when you leave the channel and come back, or reload. An incompatible one needs a newer Venora or a different plugin version.
The install was rejected.
Venora explains which check failed, for example an invalid plugin.json, an unknown permission, or a file that's too large. Nothing was saved.
How do I remove Venora?
Click Remove on Venora in the extensions page. The browser deletes the extension's storage, which includes your plugins and their settings and data.