Skip to content

Latest commit

 

History

History
130 lines (104 loc) · 4.22 KB

upgrade.md

File metadata and controls

130 lines (104 loc) · 4.22 KB
Raw
title description published date tags editor dateCreated
Upgrade
How to upgrade to the latest version
true
2023-02-07 05:38:49 UTC
setup
markdown
2019-02-15 23:53:12 UTC

DO NOT upgrade from 1.0.x using these instructions! Use the Migrate from Wiki.js v1.x instructions instead. These instructions are for 2.x installations. {.is-danger}

While upgrades are generally safe and it's very unlikely that it would result in data loss, it's your responsibility to have a proper backup of your database before performing an upgrade. Note that it's not possible to go back to a previous version of Wiki.js once the database schema has been upgraded. {.is-warning}

In-place Upgrade

Select your platform:

Platforms {.tabset}

Docker

Standalone Container

Upgrading is simply a matter of recreating the container with the latest image version:

# Stop and remove container named "wiki"
docker stop wiki
docker rm wiki

# Pull latest image of Wiki.js
docker pull ghcr.io/requarks/wiki:2

# Create new container of Wiki.js based on latest image
docker run -d -p 8080:3000 --name wiki --restart unless-stopped -e "DB_TYPE=mysql" -e "DB_HOST=db" -e "DB_PORT=3306" -e "DB_USER=wikijs" -e "DB_PASS=wikijsrocks" -e "DB_NAME=wiki" ghcr.io/requarks/wiki:2

Check out the Docker installation guide for all the possible options when creating a Wiki.js container.

Docker Compose

The following commands will pull the latest image and recreate the containers defined in the docker-compose file:

docker-compose pull wiki
docker-compose up --force-recreate -d

Linux / macOS

The commands below assume an installation within a subfolder named wiki. {.is-info}

  1. Stop the running Wiki.js instance
  2. Make a backup of your config.yml file.
cp wiki/config.yml ~/config.yml.bak
  1. Delete the application folder.
rm -rf wiki/*
  1. Download the latest version of Wiki.js.
wget https://github.com/Requarks/wiki/releases/latest/download/wiki-js.tar.gz
  1. Extract the package
tar xzf wiki-js.tar.gz -C ./wiki
cd wiki
  1. Restore your config.yml back to its original location.
cp ~/config.yml.bak ./config.yml
  1. Start Wiki.js
node server

Windows

The commands below assume an installation at folder location C:\wiki. {.is-info}

  1. Open a Powershell prompt in administrator mode.
  2. Make a backup of config.yml file.
Copy-Item "C:\wiki\config.yml" -Destination "C:\config.yml.bak"
  1. Delete the application folder contents.
Clear-Content "C:\wiki\*"
  1. If you are using Windows 7 / Windows Server 2008 R2 or older, you must run the following command. (otherwise skip this step)
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls12
  1. Download the latest version of Wiki.js:
Invoke-WebRequest -Uri "https://github.com/Requarks/wiki/releases/latest/download/wiki-js-windows.tar.gz" -OutFile "wiki-js.tar.gz"
  1. Extract the package to the final destination of your choice:
tar xzf wiki-js.tar.gz -C "C:\wiki"
cd C:\wiki

The tar utility is only available on Windows 10. On earlier versions, you'll need a 3rd-party utility like 7-zip to extract the file. {.is-warning}

  1. Copy your config.yml backup file back to it's original location.
Copy-Item "C:\config.yml.bak" -Destination "C:\wiki\config.yml"
  1. Run Wiki.js
node server

Migrate between servers

Read the transfer between servers guide to learn how to move an existing 2.x Wiki.js installation to a new server.

Note that the new server Wiki.js version doesn't need to match the old server. The installation will automatically be updated to the latest version upon restore. For example, it's perfectly safe to migrate a 2.2 installation on the old server to 2.5 on the new server. {.is-info}

{.align-abstopright}