Skip to main content

5. LXC Installation

BookStack is an open-source  wiki software  designed for organizing and storing information in a book-like structure, featuring a user-friendly interface and support for multiple languages. It allows users to create content using WYSIWYG and Markdown editors, and is available for self-hosting under the MIT License. It is especially simple, lightweight and allows for collaboration at the same time, which makes it a great tool for documentation. Heck you are reading from it right now ;). Now, there are other alternatives like grama.ax, 

Installation

Since this is a small project we will host this Bookstack instance as an LXC container inside the production Proxmox PVE1 server. Regarding backups we have one backup to our PBS VM hosted on our PVE2 and an offsite backup also via PBS. The LXC container is installed simply by using the Proxmox helper script bookstack. 

1.Enter the Shell of your Proxmox machine 

2. Copy paste the following and follow the installation steps 

bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/bookstack.sh)"

3. If you want this documentation page to be viewed publicly it is recommended to host the container on the DMZ VLAN for security purposes.

4. Also make sure you allow root access to your container with a password such that you can configure it to your needs after installation.

5. After installation you can check if your Bookstack instance is working by going to IP-Address-of-container:6875. The first time login uses the following credentials

  • Username: admin@admin .com
  • Password: password

6. If all good, you can go Inside the container to find the configuration file at

nano /opt/bookstack/.env

7. Once in there, assuming you want to make the wiki publicly accessible you can set the website name of your wiki by adjusting the value at 

APP_URL=https://wiki.example.org

8. It is assumed that you have set your reverse proxy settings correctly with any kind of proxy server. For ease of use we recommend the Caddy plugin for OPNsense which is discussed at ------> INSERT.

Back to top