Orbital Sync Setup Guide - ajgillis04/GillisDockerDepot GitHub Wiki

Orbital Sync Setup Guide

Introduction

Orbital Sync is a tool designed to sync files and data between multiple servers, ensuring that your data is consistent and up-to-date across all locations.

Prerequisites

  • Docker installed
  • Orbital Sync container running in your Docker stack

Configuration Steps

Step 1: Accessing the Orbital Sync UI

  1. Open your browser and navigate to http://<your-ip-address>:8888.
  2. Log in with your Orbital Sync credentials.

Step 2: Initial Setup Wizard

  1. Follow the initial setup wizard to configure basic settings.
  2. Choose your preferred language for the Orbital Sync interface.

Step 3: Adding Sync Locations

  1. Navigate to the Locations tab.
  2. Click Add Location.
  3. Enter the details of the location you want to sync (e.g., server address, path).
  4. Click Save.

Step 4: Configuring Sync Schedules

  1. Go to the Schedules tab.
  2. Click Add Schedule.
  3. Enter the schedule details (e.g., frequency, start time).
  4. Select the locations to include in the sync.
  5. Click Save.

Step 5: Customizing Sync Settings

  1. Navigate to the Settings tab.
  2. Customize settings such as file conflict resolution, notification preferences, and performance options.
  3. Click Save.

Step 6: Monitoring Sync Status

  1. Go to the Dashboard tab.
  2. Monitor the status of your sync operations, including progress and any errors.

Notes

  • Ensure all paths and environment variables are updated in the orbital_sync.yaml file.
  • Regularly backup your config directory to save your settings.

Troubleshooting

  • Common Issues: List common issues and solutions.
  • Logs: Check Orbital Sync logs for error messages.
  • Support: Link to the Orbital Sync community and support resources.