Install Baikal (Baïkal) in any Webhosting package

Introduction

This tutorial describes how to install Baikal on ANY Webhosting package.

Requirements

The smallest Webhosting package is sufficient for this tutorial, but you can also use any other Webhosting package, even if you already use it for other purposes.

Step 1 - Installing Baikal

1. Log in to the Customer Control Panel (CCP) at https://customercontrolpanel.de/.
2. Open the right webserver (Products -> Magnifying glass next to the webserver).
3. Click on "Plesk Overview".
4. Click on the "Files" tab in the menu on the left.
5. Download the latest version of Baikal from https://github.com/sabre-io/Baikal/releases (e.g. baikal-0.9.3.zip).
6. Drag and drop the downloaded file into the Plesk file manager.
7. Click on the uploaded file and confirm the extraction by clicking on "OK" (it may be on the bottom of the page).
8. At the right end of the line of the extracted folder, click on the three dots and then on "Rename".
9. Rename the folder to a domain you will use later (e.g. baikal.example.com).
10. Click on the folder name.

Step 2 - Creating a subdomain

1. Click on the "Website & Domains" tab in the menu on the left.
2. Click on "Add Subdomain".
3. Enter a name for the subdomain (e.g. baikal) - Use the one you defined in step 1.9.
4. Choose a domain (e.g. example.com) - Use the one you defined in step 1.9.
5. Enter a document root and append /html (e.g. baikal.example.com/html).
6. Click on "OK".

Step 3 - SSL Certificate

1. Click on "SSL/TLS Certificates".
2. Click on "Add SSL/TLS Certificate".
3. Click the left-most "Install" button.
4. Enter your email address.
5. Enable the last checkbox. (This will not only secure the subdomain but also www.[subdomain].)
6. Click on "Get it free".
7. Check the slider saying "Redirect from http to https".
8. Check the slider saying "OCSP Stapling".

Step 4 - Configuring Baikal

1. Open the subdomain you created earlier (e.g. https://baikal.example.com).
2. Select the time zone you want to use (e.g. Europe/Berlin).
3. Choose if you want to enable CardDAV, CalDAV or both (normally you want to enable both).
4. Set an admin password.
5. Click on "Save changes".
6. Click on "Start using Baikal".
7. Log in with the admin password you set earlier.

Step 5 - Creating a user

1. Click on "Users and resources" in the navigation bar.
2. Click on "Add user".
3. Enter a username (e.g. john.doe).
4. Enter a display name (e.g. John Doe).
5. Enter an email address (e.g. johndoe@example.com).
6. Enter a password (twice).
7. Click on "Save changes".
8. Click on the "Information" icon next to the user you just created.
9. Copy the URI.

Step 6 - Setting up your device

Because devices are different, I can't give you a step-by-step guide for every device. But I can give you the information you need to set up your device.
In the following you'll find links to documents for the most common devices:

Tutorials can easily be found by searching for "caldav [device]" or "carddav [device]" on your favorite search engine.

Conclusion

You've now successfully installed Baikal and set it up on your device.

From now on, your Baikal instance management will be available at your subdomain (e.g. https://baikal.example.com).

Thank you for using this tutorial!

License

Copyright (c) 2023 Konstantin Protzen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contributor's Certificate of Origin

By making a contribution to this project, I certify that:

1. The contribution was created in whole or in part by me and I have the right to submit it under the license indicated in the file; or

2. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same license (unless I am permitted to submit under a different license), as indicated in the file; or

3. The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

4. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the license(s) involved.