Syncthing

Introduction

  • Getting Started
    • Installing
      • Syncthing
    • Configuring
  • An intro to the GUI
    • Folder View
    • Device View
  • Project Presentation
    • Syncthing
    • syncthing-android
    • syncthing-inotify
    • Syncthing-GTK

For Users

  • FAQ
    • General
      • What is Syncthing?
      • Is it “syncthing”, “Syncthing” or “SyncThing”?
      • How does Syncthing differ from BitTorrent Sync?
    • Usage
      • What things are synced?
      • Is synchronization fast?
      • Should I keep my device IDs secret?
      • What if there is a conflict?
      • How to configure multiple users on a single machine?
      • Is Syncthing my ideal backup application?
      • Why is there no iOS client?
      • Why does it use so much CPU?
      • How can I exclude files with brackets ([]) in the name?
      • Why is the setup more complicated than BTSync?
      • How do I access the web GUI from another computer?
      • Why do I see Syncthing twice in task manager?
      • Where do Syncthing logs go to?
      • How do I upgrade Syncthing?
      • Where do I find the latest release?
  • Firewall Setup
    • Port Forwards
    • Local Firewall
    • Remote Web GUI
      • Tunneling via SSH
  • Starting Syncthing Automatically
    • Windows
      • Third-party Tools
      • Start on Login
      • Run independent of user login
    • Mac OS X
      • Using homebrew
      • Without homebrew
    • Linux
      • Ubuntu like systems
      • Supervisord
      • systemd
        • How to use the system instance
        • How to use the user instance
        • Using the journal
        • Debugging
  • Syncthing Configuration
    • Synopsis
    • Description
    • Config File Format
      • configuration
      • folder
      • device
      • gui
  • Community Contributions
    • GUI Wrappers
      • Cross-platform
      • Android
      • Ubuntu
      • Windows
      • OS X
      • Kindle Touch
    • Packages and Bundlings
      • ArchLinux
      • arkOS
      • Debian / Ubuntu
      • Docker
      • Fedora
      • FreeBSD
      • OpenSUSE
      • Synology NAS
      • QNAP NAS
    • Integrations
      • REST API Bindings
      • Ports
      • Configuration management
  • Folder Master
  • Ignoring Files
    • Synopsis
    • Description
    • Patterns
    • Example
    • Effects on “In Sync” Status
  • Security Principles
    • Information Leakage
      • Global Discovery
      • Local Discovery
      • Upgrade Checks
      • Usage Reporting
      • Sync Connections (BEP)
      • Web GUI
    • In Short
  • Syncthing
    • Synopsis
    • Description
    • Options
    • Exit Codes
    • Development Settings
    • See also
  • File Versioning
    • Description
    • No File Versioning
    • Simple File Versioning
    • Staggered File Versioning

For Developers

  • Building Syncthing
    • Branches and Tags
    • Prerequisites
    • Building (Unix)
    • Building (Windows)
    • Subcommands and Options
    • Building without Git
    • Building with Docker
  • Debugging Syncthing
    • Environment Variables
      • STTRACE
      • STPROFILER
      • STGUIASSETS
      • STCPUPROFILE
      • STHEAPPROFILE
      • STBLOCKPROFILE
      • STPERFSTATS
      • STNOUPGRADE
      • GOMAXPROCS
      • GOGC
  • Understanding Device IDs
    • Description
    • Keys
    • Device IDs
      • Connection Establishment
    • An Aside About Collisions
    • Problems and Vulnerabilities
      • Discovery Spoofing
      • Long Device IDs are Painful
  • Event API
    • Description
    • Event Structure
    • Events
      • ConfigSaved
      • DeviceConnected
      • DeviceDisconnected
      • DeviceDiscovered
      • DeviceRejected
      • DownloadProgress
      • FolderCompletion
      • FolderRejected
      • FolderSummary
      • ItemFinished
      • ItemStarted
      • LocalIndexUpdated
      • Ping
      • RemoteIndexUpdated
      • Starting
      • StartupCompleted
      • StateChanged
  • Issue Management
    • Labels
    • Milestone
    • Assignee
    • Locking
  • Interacting with Jenkins
  • Creating a Release
    • Prerequisites
    • Process
  • Release Schedule
    • Structure
    • Patch Releases
    • Minor Releases
    • Major Releases
  • REST API
    • Description
    • API Key
    • System Endpoints
      • GET /rest/system/config
      • GET /rest/system/config/insync
      • POST /rest/system/config
      • GET /rest/system/connections
      • GET /rest/system/discovery
      • POST /rest/system/discovery/hint
      • POST /rest/system/error/clear
      • GET /rest/system/error
      • POST /rest/system/error
      • GET /rest/system/ping
      • POST /rest/system/ping
      • POST /rest/system/reset
      • POST /rest/system/restart
      • POST /rest/system/shutdown
      • GET /rest/system/status
      • GET /rest/system/upgrade
      • POST /rest/system/upgrade
      • GET /rest/system/version
    • Database Endpoints
      • GET /rest/db/browse
      • GET /rest/db/completion
      • GET /rest/db/file
      • GET /rest/db/ignores
      • POST /rest/db/ignores
      • GET /rest/db/need
      • POST /rest/db/prio
      • POST /rest/db/scan
      • GET /rest/db/status
    • Statistics Endpoints
      • GET /rest/stats/device
      • GET /rest/stats/folder
    • Misc Services Endpoints
      • GET /rest/svc/deviceid
      • GET /rest/svc/lang
      • GET /rest/svc/report
 
Syncthing
  • Docs »
  • Search

© Copyright 2015, The Syncthing Authors. Last updated on Jan 30, 2022.

Built with Sphinx using a theme provided by Read the Docs.