Skip to content

Latest commit

 

History

History
96 lines (58 loc) · 4.67 KB

unraid-installation-guide.md

File metadata and controls

96 lines (58 loc) · 4.67 KB
Raw

Unraid Docker Baikal Installation Guide

If you would like to roll your own Baikal installation within Unraid straight from Docker Hub, this is the guide for you. Many thanks to @Joshndroid for contributing this guide.

Prerequisites

This Unraid Docker Installation guide assumes a few things:

  1. Enabled Docker in Unraid (see Docker Management)
  2. Enabled Community Applications (CA) in Unraid
  3. Enabled ability to utilize Docker Hub for search results (see settings within the apps tab)
  4. (Optional) A reverse proxy container and network to allow for certificate handling & SSL connections

Installation Note – You can change the Docker image tag in the repository in the later steps to one that is suitable for your setup. See ckulka/baikal (Docker Hub) or ckulka/baikal-docker (Github) for a list of all available Docker image tags.

Further Installation Note – If you utilise an external database such as MariaDB, please ensure that Baikal and the database can connect correctly:

  • the database and user are created
  • the database and Baikal containers are on the same network

Installation

With that in mind, the installation of Baikal is rather simple once you have the above setup.

  1. Head over to apps and search for "Baikal".

  2. Click on the ckulka/baikal repository within the search results to begin the installation of Baikal.

  3. On the right in the template, switch from Basic View to Advanced View.

  4. Ensure that the Docker image tag in your Docker repository line is the image variant you want.

    For more details, see Image Variants and the Tags tab in ckulka/baikal (Docker Hub).

  5. Set your Icon URL to https://raw.githubusercontent.com/sabre-io/sabre.io/master/source/img/baikal.png (Baikal logo from the official maintainers).

  6. Set your WebUI to http://[IP]:[PORT:80]/

    Change this to whatever suits your local server port requirements - see below.

  7. Set Extra Parameters to --restart=always.

    This will restart the container automatically if it ever crashes.

  8. (Optional) Set your network type as needed.

    For example, set it to the same one of your reverse proxy container that handles HTTPS termination and certificate renewal.

  9. Add in your static IP address that you will utilize for Baikal.

    This will make it easier to get to your hosted instance.

  10. Add a new path with

    • Name is Config
    • Container Path is /var/www/baikal/config
    • Host Path is /mnt/user/appdata/baikal/config (change to where you store it on local server)
    • Default Value is /mnt/user/appdata/baikal/config (see above)
    • Acccess Mode is Read/Write
    • Description is Container Path: /var/www/baikal/config

  11. Add a new path with

    • Name is Specific
    • Container Path is /var/www/baikal/Specific
    • Host Path is /mnt/user/appdata/baikal/specific (change to where you store it on local server)
    • Default Value is /mnt/user/appdata/baikal/specific (see above)
    • Acccess Mode is Read/Write
    • Description is Container Path: /var/www/baikal/Specific

  12. Now add in a port with

    • Name is Port
    • Container Port is 80
    • Host Port is 80 (change to the port where you want to expose Baikal over HTTP on your local server)
    • Default Value is 80 (see above)
    • Connection Type is TCP
    • Description is Container Port: 80

  13. Click Apply to download and install the container.

  14. Start your Baikal docker container

  15. (Optional) Set up SSL

    Head over to your SSL certificate provider container of choice and set-up as necessary to serve the certificates of your Baikal instance for your domain.

  16. Head over to your Baikal web interface and start the Baikal initialisation process.

    You can access the web interface on the exposed port http://[IP]:[PORT].

    During the Baikal initialisation process, you can choose between a SQLite database or an external database such as MariaDB. When using an separate container as external database, make sure the Baikal and database container are on the same network.

    If you are choosing to go with an external database container, you will need to set it up beforehand in order for Baikal to connect to it correctly, e.g. setting up the database user.

Your Baikal instance now up all set, congratulations 🎉 🙌