Skip to content

User Guide

Abijith Balaji edited this page Jun 28, 2025 · 2 revisions

User Guide

Getting Started

Ogresync is designed to be simple - just install and let it handle the rest.

First Time Setup

  1. Download and Run - Get Ogresync from the releases page and run it
  2. Follow the Wizard - The setup guide walks you through everything
  3. Choose Your Folder - Pick the folder you want to keep synced
  4. Connect to Repository - Link to your GitHub repository (create one if needed)
  5. Done! - Ogresync starts syncing automatically

Daily Use

Once set up, Ogresync works in the background:

  • Make Changes - Edit, add, or delete files normally
  • Auto Sync - Changes sync automatically within seconds
  • Check Status - Look for the Ogresync icon in your system tray
  • Conflicts - If needed, Ogresync will help you resolve conflicts

Key Features

Automatic Syncing

  • Watches your folder for changes
  • Syncs immediately when you save files
  • Works even when you're offline (syncs when back online)

Backup Protection

  • Creates backups before making changes
  • Keeps multiple backup versions
  • Easy restore from the backup folder

Conflict Resolution

When multiple people edit the same file:

  1. Ogresync detects the conflict
  2. Shows you both versions
  3. Helps you choose which to keep or merge them

System Tray Control

Right-click the Ogresync icon to:

  • Pause/resume syncing
  • Open your synced folder
  • View sync status
  • Access settings

Managing Your Files

What Gets Synced

  • All files in your chosen folder
  • Subfolders and their contents
  • File changes, additions, and deletions

What Doesn't Sync

  • Very large files (over 100MB by default)
  • System files and hidden folders
  • Files listed in .gitignore (if present)

File Conflicts

If two people edit the same file:

  1. Ogresync will pause and notify you
  2. Open the conflict resolution tool
  3. Choose to keep your version, their version, or merge both
  4. Ogresync resumes syncing

Troubleshooting

Sync Stopped Working?

  • Check your internet connection
  • Look for the Ogresync icon - restart if missing
  • Check the repository is accessible

Files Not Syncing?

  • Make sure they're in the synced folder
  • Check if they're too large or excluded
  • Restart Ogresync if needed

Need to Start Over?

  • Close Ogresync
  • Delete the config file (see Troubleshooting for location)
  • Restart Ogresync to run setup again

Need More Help?

Clone this wiki locally