Today we will be installing Wiki.js Docker container on a Raspberry Pi 4 using Portainer. This is episode 31 in our Raspberry Pi series.
Difficulty=Easy
Prerequisites:
If you have not followed our previous episodes we recommend you do so before attempting to follow any of our episodes. Each tutorial follows a custom setup and you may miss some information. However, if you meet all the following prerequisites then you should be fine to proceed.
- A Raspberry Pi with Raspberry Pi OS installed.
- Secured Raspberry Pi.
- Docker and Portainer Installed.
- An AppData folder to be used to store the config and data folders.
- A device to initiate an SSH terminal session.
What is Wiki.js?.
Wiki.js is a self-hosted open-source Wiki application that is supported and actively used by some big names in the tech industry. It integrates with over 50+ external applications like AWS, Azure, and Facebook. It can be used for business teams or technology enthusiasts looking for somewhere to store documentation.
It offers several editors, plain text, markdown, and a visual builder with more in development. Easily search for the content you need and set up user authentication to secure content and restrict access. 2FA is also supported. This Wiki has it all and we highly recommend it.
How to install Wiki.js Docker on a Raspberry Pi 4
Step 1 – Create the folders needed for the Wiki.js Docker container.
We will need to create two folders in order to set up our Wiki.js Docker container.
The two folders needed are the “config” and “data” folders.
Open up a terminal or Putty application (See our guide on How to install Putty on Windows).
Connect to your Raspberry Pi via SSH (secure shell).
ssh -p PORT [email protected]
Navigate to your “Appdata” folder or the place where you store all your container’s persistent configuration data.
cd /srv/YOURUSBDISKUUID/Appdata
Create a folder called “wikijs“.
mkdir wikijs
Navigate into the “wikijs” folder.
cd wikijs
Create the “config” folder where all the Plex configuration data will reside.
mkdir config
Now navigate into the “config” folder.
cd config
From here you will need to get your “absolute path” for your “config” folder.
pwd
Copy the output of the pwd command and paste it into a text file. You will need this in Step 2.
You will now need to move back into the “wikijs” folder in order to create the second folder needed called “data“.
cd ..
Now you should be back in the “wikijs” folder. You can now create the second folder needed called “data“.
mkdir data
Now navigate into the “data” folder.
cd data
From here you will need to get your “absolute path” for your “data” folder.
pwd
Copy the output of the pwd command and paste it into a text file. You will need this in Step 2.
Step 2 – Create the Wiki.js Container Using Portainer and a Stack.
Navigate to your Portainer dashboard and log in.
From the left-hand menu click on “Stacks“.
Now in the Stacks dashboard click on “Add a stack“.
In the “Name” field enter “wikijs“
Wiki.js Docker Compose Stack
---
version: "2.1"
services:
wikijs:
image: lscr.io/linuxserver/wikijs:latest
container_name: wikijs
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
volumes:
- /path/to/config:/config
- /path/to/data:/data
ports:
- 3000:3000
restart: unless-stopped
Replace the “path/to/config” and “path/to/data” fields with the absolute paths you obtained in Step 1 when using the pwd command.
You will also need to change the “PUID“, “PGID” and the left side of the colon “port” number (only required if port 3000 is already in use) to match your setup.
You can find out how to get your PUID and PGID by following our episode 31 YouTube video tutorial.
Once you have completed that you are ready to click “Deploy the stack“.
If you navigate to “Containers” in the left menu
You should now see your “wikijs” container in the list “click on the logs icon“.
Give the container a few minutes to fully internalize. You can check its progress in Portainer using the “wikijs log”.
When it has completed the first load, you should now be able to access the Wikijs installation wizard from a browser.
Open up your browser of choice and enter the following into the address bar. Change “YOURRASPBERRYPIIP” with the IP address of your Raspberry Pi and port if you changed it from the default :3000.
http://YOURRASPBERRYPIIP:3000
You should now see the Wiki.js installation wizard page.
Add an Administrator email address, and password.
Under the domain name put “http://wikijs.local”. If you want to use your own domain you can set this up using NGINX Proxy Manager. It is not covered in today’s tutorial however if you would like us to cover it in a later episode please let us know in the comments below or on our YouTube video for this episode.
If you would like to know how to configure Wiki.js. Please follow our YouTube tutorial for this episode as we explain the process in detail there.
We need your support.
We hope you enjoyed this episode and that it was helpful and you got benefit out of it.
If you did, please consider supporting our channel by Subscribing to our YouTube channel, and liking and sharing our content.
You can also make a donation via Paypal or become a Patreon if you wish to do so.
You can also follow us on Facebook or Twitter.
Please ask if you have any questions or requests in the comments below or on YouTube.
0 Comments