Installing TiddlyWiki

Discover our Public Cloud offer

Shared Hosting for Everyone, imagined by developers, for developers.

Discovering the Public Cloud

TiddlyWiki is a “non-linear web notebook”. It is dedicated to organizing snippets of information (such as notes, images, and more) by saving them and smartly link them. It can be served as a static HTML file or using a Node.js site.

Install Using the Marketplace

Our Marketplace offers a script to install TiddlyWiki automatically. In your administration panel, go to the Web > Sites section, click on the Install an application button, and select the TiddlyWiki entry by clicking on the cogwheel.

Fill in the fields according to your preference, and run the installer.

Manually

Using a Static File and WebDAV

You can simply use the WebDAV remote access to edit your TiddlyWiki and serve it publicly in read-only mode using the static site type:

  1. Get the latest empty TiddlyWiki at the download page
  2. Using FTP or SFTP, upload the file to your account (e.g. $HOME/notes/wiki/index.html)
  3. Open your browser and point it to https://webdav-[account].alwaysdata.net/[path/from/HOME]/[filename].html (e.g. https://webdav-[account].alwaysdata.net/notes/wiki/index.html), and use your account username and account password credentials to authenticate on the basic auth window (you can also create a dedicated WebDAV user to do so)

You can now edit you TiddlyWiki, the saving action will pass through the WebDAV protocol to update the remote HTML file.

If you want to access it from a public URL in a read-only mode (without auth), create a new static site in your Web > Sites section. Use the directory you uploaded your file to as the Root directory directive.

Use the Node.js Server Version

If you want to use more advanced features, like authentication, you can use the Node.js version:

  1. Login through SSH

  2. Install globally the TiddlyWiki package via npm:

    $ npm install --global tiddlywiki
    
  3. Create a new repository for your notebook:

    $ tiddlywiki $HOME/[path/to/repository] --init server
    
  4. Create a new Node.js site:

    • Node.js version: min. 10.x
    • Command: ~/.npm-packages/bin/tiddlywiki . --listen host=$IP port=$PORT
    • Working directory: [path/to/repository]

Authentication

You can add a basic auth layer on your TiddlyWiki served by Node.js:

  1. In your notebook repository (where the tiddlywiki.info file is located), create a users.csv file with the following content:

    username,password
    [user1],[pwd1]
    [user2],[pwd2]
    ...
    
  2. Edit the Command field in the Site configuration, and add credentials=users.csv "readers=(authenticated)" "writers=user1,user2"

    • replace (authenticated) by (anon) to allow a public read-only access
    • users login can be used as well as readers as writers to set fine-grained access permissions

Adding a plugin

Here we add the FR translation plugin now, as well as the Freelinks plugin as an example.

  1. Edit the tiddlywiki.info file by adding your plugin to the plugins section:

    "plugins": [
        "tiddlywiki/tiddlyweb",
        "tiddlywiki/filesystem",
        "tiddlywiki/highlight",
        "tiddlywiki/freelinks"
    ],
    

The tiddlywiki.info file is a standard JSON file, be sure to stick to the syntax, especially the comma as an array’s entries separator (here after "tiddlywiki/highlight",).

  1. For translation, add the following content after the themes section:

    "languages": [
        "en-EN",
        "fr-FR"
    ],
    

    You should have this result:

    "plugins": [
        "tiddlywiki/tiddlyweb",
        "tiddlywiki/filesystem",
        "tiddlywiki/highlight",
        "tiddlywiki/freelinks"
    ],
    "themes": [
        "tiddlywiki/vanilla",
        "tiddlywiki/snowwhite",
    ],
    "languages": [
        "en-EN",
        "fr-FR"
    ],
    
  2. Save, and from your site’s administration panel, restart it so that TiddlyWiki can take these changes into account.