Setting up syncthing as a service on openSUSE and other Linux distributions

 In this blog post, we'll guide you through setting up Syncthing, an open-source continuous file synchronization tool, as a systemd service on openSUSE. Additionally, we'll provide instructions for Debian/Ubuntu, Arch Linux, and Fedora users, though these will be commented out for you to uncomment as needed.

Šiame blogo įraše aptariame, kaip sukurti syncthing kaip sisteminį servisą openSUSE ir kitose Linux distribucijose. Skriptas automatiškai įdiegs syncthing, sukurs serviso failą, nustatys leidimus ir įjungs servisą. Pateikiamos instrukcijos įvairioms distribucijoms, nurodomi privalumai ir trūkumai, bei galimi patobulinimai.

#!/bin/bash

# Naudotojo vardo kintamasis / Username variable
USERNAME=$(whoami)

# Įdiek syncthing / Install syncthing
sudo zypper install -y syncthing
# sudo apt install -y syncthing  # Uncomment for Debian/Ubuntu based systems
# sudo pacman -S syncthing       # Uncomment for Arch Linux
# sudo dnf install -y syncthing  # Uncomment for Fedora

# Sukurk systemd serviso failą / Create systemd service file
SERVICE_FILE=/etc/systemd/system/syncthing.service
sudo tee $SERVICE_FILE > /dev/null <<EOL
[Unit]
Description=Syncthing - Open Source Continuous File Synchronization
Documentation=man:syncthing(1)
After=network.target

[Service]
User=$USERNAME
ExecStart=/usr/bin/syncthing -no-browser -logfile=/var/log/syncthing.log
Restart=on-failure
SuccessExitStatus=3 4
RestartForceExitStatus=3 4

[Install]
WantedBy=multi-user.target
EOL

# Pakeisk failų leidimus / Set file permissions
sudo chmod 644 $SERVICE_FILE

for command in enable start status; do
    sudo systemctl $command syncthing.service
done

Purpose of the Script

This script automates the installation and setup of Syncthing as a systemd service. By doing so, Syncthing will start automatically with your system, ensuring your files are synchronized continuously without requiring manual intervention each time you boot up your computer.

How the Script Works

1. Install Syncthing: The script begins by installing Syncthing using the zypper package manager, specific to openSUSE. Alternative commands for Debian/Ubuntu, Arch Linux, and Fedora are included but commented out. Uncomment the relevant line for your distribution before running the script.

2. Create systemd Service File: It creates a systemd service file for Syncthing at /etc/systemd/system/syncthing.service. This file includes necessary configurations to manage Syncthing as a service, such as setting the user, specifying the executable, and defining restart policies.

3. Set File Permissions: The script sets appropriate permissions for the service file to ensure it can be read and executed by systemd.

4. Enable and Start the Service: It enables the Syncthing service to start automatically at boot time and starts the service immediately.

5. Check Service Status: Finally, the script checks and displays the status of the Syncthing service to confirm that it is running correctly.

Advantages and Disadvantages

Advantages:

• Automation: The script simplifies the process of setting up Syncthing as a service, saving time and reducing the risk of errors.
• Reliability: With Syncthing running as a service, your file synchronization is more reliable as it starts with the system.
• Cross-Distribution Compatibility: The script includes commands for multiple Linux distributions, making it adaptable to different environments.

Disadvantages:

• Manual Editing Required: Users need to manually uncomment the appropriate installation command for their Linux distribution.
• System-Specific Adjustments: Some users might need to adjust the script slightly based on their specific system configurations.

Potential Enhancements

• User Input: Modify the script to accept user input for selecting the Linux distribution, making it more user-friendly.
• Error Handling: Add error handling to manage potential issues during installation and service setup.
• Logging: Implement logging to provide more detailed information in case of failures.

How to Use the Script

1. Download the Script: Save the script to a file, for example, install_syncthing_service.sh.
2. Edit the Script: Uncomment the installation command that corresponds to your Linux distribution.
3. Make the Script Executable: Run chmod +x install_syncthing_service.sh to make the script executable.
4. Run the Script: Execute the script with ./install_syncthing_service.sh.

By following these steps, you'll have Syncthing set up as a systemd service, ensuring your file synchronization runs smoothly and reliably every time you start your computer.