Self-hosted LiveSync Setup for Obsidian App on CasaOS

Introduction

This tutorial provides a step-by-step guide to setting up a self-hosted LiveSync server for the Obsidian app using CasaOS. LiveSync allows you to synchronize your notes across different devices effortlessly. CasaOS is a user-friendly platform that simplifies the process of managing applications on your local server.

Step 1: Install CasaOS

1. Download CasaOS:

   • Visit the CasaOS website to download the latest version.

2. Install CasaOS:

   • Follow the installation instructions provided on the website for your specific operating system (Linux, Raspberry Pi, etc.).

3. Access CasaOS:

   • After installation, open your web browser and navigate to the CasaOS dashboard, typically at http://localhost:port, replacing "port" with the configured port number.

Step 2: Set Up Docker

1. Install Docker:

   • If Docker is not installed by default with CasaOS, you can install it using the following command:

   sudo apt-get install docker.io
   

2. Start Docker:

   • Ensure Docker is running by executing:

   sudo systemctl start docker
   sudo systemctl enable docker
   

Step 3: Install LiveSync Server

1. Clone the LiveSync Repository:

   • Open the terminal and run:

   git clone https://github.com/vrtmrz/obsidian-livesync.git
   

2. Navigate to the LiveSync Directory:

   cd obsidian-livesync
   

3. Build the Docker Image:

   • Execute the following command to build the Docker image:

   docker build -t obsidian-livesync .
   

4. Run the LiveSync Container:

   • Start the LiveSync service with this command:

   docker run -d -p 8080:8080 -v /path/to/your/obsidian/vault:/vault obsidian-livesync
   

   • Replace /path/to/your/obsidian/vault with the actual path to your Obsidian vault.

Step 4: Configure Obsidian for LiveSync

1. Install the LiveSync Plugin:

   • Open Obsidian and go to Settings > Community Plugins > Browse.
   • Search for "LiveSync" and click on Install.

2. Configure the Plugin:

   • After installation, enable the LiveSync plugin and configure it by entering the URL of your LiveSync server (e.g., http://localhost:8080).

Step 5: Test the LiveSync Setup

1. Create a Test Note:

   • In Obsidian, create a new note to test synchronization.

2. Check Synchronization:

   • Use another device connected to the same network to verify that the note syncs correctly.

Conclusion

You have successfully set up a self-hosted LiveSync server for the Obsidian app using CasaOS. This setup allows seamless synchronization of your notes across devices. For further enhancements, consider exploring additional plugins in Obsidian or customizing your CasaOS environment. Enjoy your efficient note-taking and synchronization experience!