Skip to content

Setup Wizard Guide

Jump to bottom
Abijith Balaji edited this page Jun 28, 2025 · 3 revisions

Setup Wizard Guide

The setup wizard makes it easy to get Ogresync running, even if you've never used Git before.

Before You Start

Required Software:

Recommended:

  • Create a private repository on GitHub for your files (keeps them secure)

Step-by-Step Setup

Step 1: Choose Your Folder

  • Pick the folder you want to keep synced
  • Can be an existing folder with files, or create a new empty one
  • This folder will be connected to your GitHub repository

Step 2: Git Setup

  • Ogresync checks if Git is installed
  • If not found, install Git and restart the setup
  • Git handles the actual file syncing behind the scenes

Step 3: Repository Connection

Option A: New Repository

  • Ogresync can create a new repository on GitHub for you
  • Just provide your GitHub username and a name for the repository

Option B: Existing Repository

  • Provide the URL of your existing GitHub repository
  • Format: https://github.com/username/repository-name.git

Step 4: GitHub Authentication

You'll need a Personal Access Token (like a password for apps):

  1. Go to GitHub → Settings → Developer Settings → Personal Access Tokens
  2. Click "Generate new token"
  3. Give it a name like "Ogresync"
  4. Select permissions: repo (for private repos) or public_repo (for public repos)
  5. Copy the token and paste it into Ogresync

Step 5: Initial Sync

  • If both your folder and repository have files, Ogresync will help merge them
  • Creates a backup before making any changes
  • May ask you to resolve conflicts if files overlap

Step 6: Complete!

  • Ogresync saves your settings
  • Starts monitoring your folder automatically
  • Look for the Ogresync icon in your system tray

Common Setup Issues

"Git not found"

  • Install Git from git-scm.com
  • Restart your computer after installing
  • Run Ogresync setup again

"Can't connect to repository"

  • Check the repository URL is correct
  • Make sure your GitHub token has the right permissions
  • Verify your internet connection

"Permission denied"

  • Your GitHub token might not have repo access
  • Create a new token with repo permissions
  • Make sure the repository exists and you own it

Files not merging properly

  • Don't worry! Ogresync creates backups first
  • Check the _ogresync_backups folder in your synced directory
  • You can manually copy files if needed

After Setup

Once setup is complete:

  • Ogresync runs automatically when you start your computer
  • Files sync within seconds of saving
  • Check the system tray icon to see sync status
  • Right-click the icon for options and settings

Need to Change Settings?

To run setup again:

  1. Close Ogresync completely
  2. Delete the config file:
    • Windows: %APPDATA%\Ogresync\config.json
    • Linux: ~/.config/ogresync/config.json
  3. Restart Ogresync

Still Need Help?

Clone this wiki locally