Escale documentation

Escale (French: stop, halt, stopover) synchronizes files between clients that operate behind restrictive firewalls.

It makes use of common file transfer solutions (FTP) and popular cloud solutions such as Dropbox, Google Drive and WebDAV servers including Yandex Disk.

Escale maintains a relay repository in a folder inside the remote or cloud storage space and frees memory as soon as copies of a shared file have been propagated to all the clients. File modifications are also propagated.

It features end-to-end encryption, quota management, filename filters, access control and adaptive transmission latencies. It also features useful management routines such as migration, backup and restoration of relay repositories.

It can run as a daemon and simultaneously synchronize several repositories between multiple clients.

Escale’s project page is on github.com.

User guide

• Terms of use
• Installation
  • From wheel
  • From source
• General usage
  • Command-line
  • Configuration file
  • Relay backends
  • Synchronization modes
  • Encryption
  • Indexing
• How-tos
  • Choosing a relay host
  • Dropbox
  • Google Drive
  • Yandex.Disk

Developer guide

• Terms of use
• Dependencies
  • python-daemon
  • cryptography
• Communication protocol
  • Lock files
  • Index files
  • Recovery from failure
  • Multi-puller scenarios
• Persistent data
• API
  • escale.cli package
  • escale.log package
  • escale.base package
  • escale.relay package
  • escale.manager package
  • escale.encryption package
  • escale.oauth package