Feather Wiki

A tiny tool for simple, self-contained wikis!

Extensions /

Upgrade Feather Wiki

Sometimes you want to upgrade to the newest version of Feather Wiki, but you don't want to go through the trouble of downloading it from the site and importing your old wiki into the new file. This can be especially annoying if you're self-hosting since you have to then re-upload your file to your server. This extension adds a button to the Settings page that appears if your current version is less than the most recently released version of Feather Wiki.

Disclaimer #

PLEASE download a backup copy of your current Feather Wiki before using this extension so you can restore it in case anything goes wrong!

Installation #

To use the upgrader extension, you can do one of the following things:

  • Go to your Wiki Settings and add
    <script src="https://feather.wiki/extensions/v1.8.x/upgrade-feather-wiki.js"></script>
    to the "Custom Head" text area.
  • Save the upgrader extension file to the same folder as your Feather Wiki file and add
    <script src="./upgrade-feather-wiki.js"></script>
    to the "Custom Head" text area in Wiki Settings.
    • (This way requires that the search.js file always remains in the same folder as your wiki file.)
  • Go to the source code for the extension, copy the code, and paste the whole script directly into the "Custom JS" text area in Wiki Settings.

What it Does #

Once installed and your Feather Wiki is reloaded, every time you visit your Wiki Settings page, this script will download a copy of the most recent version of your current build of Feather Wiki, compare its version with your current version, and display an "Upgrade to Feather Wiki X.X.X" button at the bottom of the page if it's newer.

If you are using Wren (or if you're using Warbler and don't have access to saving to the server), clicking the Upgrade button will download a copy of your Feather Wiki upgraded to the latest version.

If you are using Warbler and can save to the server, clicking the button will first confirm that you want to overwrite your file on the server with the upgraded file, and then proceed to do just that. Again, please download a copy of your existing Feather Wiki before doing this!

When You're Done #

Since this extension downloads a copy of the latest Feather Wiki every time you load the Settings page, please be sure to remove the extension after you use it and have confirmed that the upgraded version works properly.

Commenting it out should be sufficient, but please only use it when you are actively checking if there is a newer version released.


Previous Versions #

Starting with Version 1.8.0, extensions are now stored in paths that include the minor version number (i.e. extensions for version 1.8.0 are stored in extensions/v1.8.x/) to indicate that they are incompatible with lower version numbers. The version of this extension compatible with versions of Feather Wiki below 1.8.0 can still be found at https://feather.wiki/extensions/upgrade-feather-wiki.js, but the old version will no longer receive updates.