Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lamyj/sneakersync
Synchronize files through the sneakernet
https://github.com/lamyj/sneakersync
removable-drives rsync sneakernet synchronization
Last synced: about 2 months ago
JSON representation
Synchronize files through the sneakernet
- Host: GitHub
- URL: https://github.com/lamyj/sneakersync
- Owner: lamyj
- License: mit
- Created: 2017-10-07T08:05:00.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-09-20T09:48:27.000Z (over 4 years ago)
- Last Synced: 2024-11-07T06:43:32.863Z (about 2 months ago)
- Topics: removable-drives, rsync, sneakernet, synchronization
- Language: Python
- Homepage:
- Size: 96.7 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Sneakersync
Synchronize files through the [sneakernet](https://en.wikipedia.org/wiki/Sneakernet), i.e. using a removable drive.
Requirements:
* [rsync](https://rsync.samba.org/). The version must support extended attributes (`-X` flag).
* A removable drive with a filesystem matching the source and target computers.
* Feet or a compatible mean of transportation of the removable drive between computers.
## Installation
Simply run `pip install sneakersync`.
## Configuration
The configuration is a [YAML](https://en.wikipedia.org/wiki/YAML)-formatted file that contains *modules* (directories to be synchronized) and *filters* (rules that exclude or include files or directories). Each module must contain a *root* entry (the top-level path to be synchronized) and may contain filters; if no filter is specified, all files and directories below the root of the module are included. Filters are defined by a list of *include* or *exclude* directives.
A minimal example which synchronizes the home folder of a user would look like:
```yaml
modules:
- root: /home/john.doe
```
To exclude a directory (and its content) and files with a given extension from a module, add a *filters* directive:
```yaml
modules:
- root: /home/john.doe
filters:
- exclude: /home/john.doe/.firefox/caches
- exclude: *.pyc
```
To filter entries from all modules, use the top-level *filters* directive:
```yaml
modules:
- root: /home/john.doe
- root: /home/jane.blogs
filters:
- exclude: .firefox/caches
```
Filters defined at the top-level will have priority over module-level filters.
Each module can have a host-specific root, e.g. if your username differs between computers, with the following syntax:
```yaml
modules:
- root:
first.host: /home/john.doe
second.host: /home/john
```
If host-specific roots are used, sending or receiving using an undeclared host will cause an error.
## Usage
1. Create a filesystem on a removable drive that matches the source and target computers.
2. Optional, but highly recommended: [encrypt](https://en.wikipedia.org/wiki/Disk_encryption) your removable drive.
3. Store the [configuration](#configuration) in a file named `sneakersync.cfg` on the root of the drive.
4. To send data, run `sneakersync send `.
5. Move your drive to the other computer and plug it in.
6. To receive data, run `sneakersync receive `.
Known limitations:
* The last access time (`atime`) is not preserved: rsync needs to access files in order to transfer them.
* The creation / meta-data change time (`ctime`) is not preserved: this attribute is not user-modifiable.