How To Install rapphy243/chibisafe

How To Install rapphy243/chibisafe

Prerequisites And Notes

This is an okay guide that I might update randomly. Going into installing this, you should have basic knowledge of docker/docker-compose, Portainer, and knowledge about reverse proxies. Jun 6th UPDATE - The latest version of Chibisafe was released with better docker support. I would recommend referring to their guide on how to deploy with Docker.

You can also technically ignore this whole entire guide by cloning my repo and editing your files locally. This guide was written for Portainer because it doesn't allow you to locally build docker containers through their gui. The workaround is to use a git repository to allow Portainer to build Chibisafe.

First, you need to have a Linux server with a reasonably up-to-date operating system with Docker and Docker-Compose installed. While it is possible that Chibisafe can be ran using Windows, this guide will not show you how. While technically not required, you should set up and use Portainer. Portainer is a web-gui for Docker, which makes it easy to manage and set up Docker containers. You will also need a reverse proxy installed. I recommend using Nginx Proxy Manager because it has a web-gui, which makes it super simple to use.

You should already have Docker, the commands to install Docker and Docker-Compose are listed below. (Following the guide on Docker's official wiki)

Note: As of editing this, the installation method for docker-compose has changed. The commands listed below are not up to date.

sudo apt-get update
sudo apt-get upgrade
sudo apt-get install ca-certificates curl gnupg lsb-release
curl -fsSL | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg]
echo $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli
sudo curl -L "$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
sudo curl -L
sudo curl -o /etc/bash_completion.d/docker-compose

I recommend this video by The Digital Life on how to install and use Portainer.

Setup Your Own Repository

First, make a fork of rapphy243/chibisafe on Github by clicking the fork button in the top right corner of the repository page.

Second, edit "docker-compose.yml" with your own values. NOTE to not put in private information such as your SECRET, ADMIN_ACCOUNT, or ADMIN_PASSWORD. We will put these values through Portainer to not expose them. (You can also use Portainer's environment variables, but I personally have had issues with lots of variables)

Third (Technically not required), we want to personalize your fork to include your own information/assets. Go to "src/site/assets/images" to change logos, backgrounds and etc. To edit text, go to "src/site/pages" to edit the information displayed on the homepage, faq, etc. When making changes after you set up Chibisafe, you have to sure you delete any previous Chibisafe docker images. Portainer does not rebuild the container when redeploying your changes, so you have to remove the Image and Container to let Docker build a new one with updated assets.

Installing Chibisafe Through Portainer

First, you should have already logged into your Portainer GUI. Next, we want to click on our Docker environment, and on the left sidebar click Stacks.

Now, click New Stack.

Once you are in the menu, choose a name for your stack, and then select git repository.

For Repository URL, enter the link of your forked repository on GitHub.
For Repository Reference, enter "refs/heads/master".
For Compose Path, enter "docker-compose.yml".

Now we want to create three environment variables. Name them ADMIN_ACCOUNT, ADMIN_PASSWORD, and SECRET. (Secret Generator set to 32) Enter an admin username and password for the values, and enter a secret random key.

Hit Deploy and you should now have a container running Chibisafe. You can check if it is working by going to your serverip:5000. All you need to do now is reverse proxy the container, and then it should be live.


WeebDev/chibisafe (Original Creator's Repo)

rapphy243/chibisafe (Repo for this Guide)

Portainer Install Ubuntu Tutorial By The Digital Life

Docker Ubuntu Install Instructions

Docker-Compose Ubuntu Install Instructions

Show Comments