This page is part of a static HTML representation of the TiddlyWiki at https://tiddlywiki.com/

Installing custom plugins on Node.js

 17th June 2022 at 1:01pm

Introduction

There are several ways in which official plugins and custom plugins can be installed when using TiddlyWiki with a Node.js client-server configuration.

Note
For instructions on installing plugins from libraries to single-file wikis learn more at Plugins.

Plugin Load Order

Using the Node.js client-server configuration plugins are activated in the following order:

  1. Plugins found using the OS environment variables
  2. Plugins stored in the wiki /plugins path
  3. Plugins specified in the command line
  4. Plugins imported by drag and drop as wiki content

Important:

  • Elements lower in the list take precedence
  • Including a plugin as an ordinary tiddler by drag and drop into the browser, will result in the plugin only being active in the browser
    • It will not be available under Node.js

Option 1:

  • Using a Node.js configuration option 1 is the most common one
  • It lowers maintenence, because all plugins can be updated in one go

Option 2:

  • Option 2 is preferred if you want to work with a fixed configuration
  • Plugin updates only effect the corresponding wiki

Option 3:

  • This option allows to add and start an edition without the need to overwrite an existing tiddlywiki.info file
  • It allows you to start any edition as a client-server edition, even if the tiddlywiki.info file didn't specify it.

Option 4:

  • Is the exact same mechanism used for a single-file wiki
  • This mechanism should only be used in a Node.js configuration for testing and debugging purposes, since the plugins are stored in the tiddlers/ directory