SyncTwink 0.1.0__tar.gz

synctwink-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jake
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

synctwink-0.1.0/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.4
+Name: SyncTwink
+Version: 0.1.0
+Summary: A skinny but powerful, self-hosted file sync across your devices over a Tailscale tailnet.
+Author: Jake
+License: MIT
+Keywords: webdav,syncthing,tailscale,file-sync,self-hosted
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: WsgiDAV>=4.3.0
+Requires-Dist: cheroot>=10.0.0
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: requests>=2.28
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+# SyncTwink
+
+A skinny but powerful, self-hosted file sync across your devices over a [Tailscale](https://tailscale.com) tailnet.
+
+Two always-on servers (e.g. a **Raspberry Pi** and a **Mac Mini**) each expose
+the *same* folder over **WebDAV** for iOS Files and other clients, while
+**Syncthing** keeps the two copies replicated. Either server can go offline and
+your files stay reachable from the other.
+
+```
+        Tailnet (WireGuard, end-to-end encrypted)
+   ┌──────────────────────────────────────────────────┐
+   │                                                    │
+┌──┴──────────────┐   Syncthing replication   ┌─────────┴───────┐
+│  Raspberry Pi   │ <───────────────────────> │    Mac Mini     │
+│  • Tailscale    │                            │  • Tailscale    │
+│  • WebDAV :8080 │                            │  • WebDAV :8080 │
+│  • Syncthing    │                            │  • Syncthing    │
+└──┬──────────────┘                            └─────────┬───────┘
+   │                                                     │
+   │            WebDAV over Tailscale (HTTP/HTTPS)       │
+   └──────────────────────┬──────────────────────────────┘
+                          │
+            ┌─────────────┴─────────────┐
+            │  iPhone / iPad Files app  │  ← connects to whichever
+            │  Mac / other devices      │     server is reachable
+            └───────────────────────────┘
+```
+
+SyncTwink is the glue: a small Python package + CLI you install on **each
+server**. It configures the WebDAV service (via [WsgiDAV](https://wsgidav.readthedocs.io/)),
+sets up the Syncthing shared folder, and optionally fronts WebDAV with HTTPS
+using `tailscale serve`.
+
+## What it does
+
+- **WebDAV server** backed by WsgiDAV + cheroot, serving one folder with
+  per-user auth (basic + digest). Works with iOS Files, macOS Finder, and any
+  WebDAV client.
+- **Syncthing replication** between the two servers, configured for you via
+  Syncthing's REST API (adds the folder, pairs peers, enables file versioning).
+- **Native services** — installed as a `systemd` unit on Linux or a `launchd`
+  agent/daemon on macOS, so WebDAV starts on boot and restarts on failure.
+- **Tailscale-aware** — reads your tailnet status to print the right
+  connection URLs and can expose WebDAV over HTTPS with a valid MagicDNS cert.
+
+SyncTwink assumes Tailscale is already installed and `tailscale up` has been
+run on each machine. It does **not** manage the tailnet itself.
+
+## Quick start (run on *each* server)
+
+```bash
+# 1. Install the CLI (pick one)
+pipx install synctwink
+# or from source:
+# pipx install git+https://github.com/jchaselubitz/synctwink.git
+# pipx install .                  # from a git clone
+
+# 2. Create a config (generates a WebDAV password for you)
+sudo synctwink init --user jake --data-dir /srv/synctwink/data
+
+# 3. Find this machine's Syncthing device id (after Syncthing has run once)
+synctwink syncthing id
+```
+
+Put **each server's** device id into the **other server's** config under
+`syncthing.peers`, then on both machines:
+
+```bash
+sudo synctwink install     # installs deps, configures Syncthing, starts WebDAV
+synctwink status           # health check + connection URLs
+```
+
+See [`docs/INSTALL.md`](docs/INSTALL.md) for the full walkthrough and
+[`docs/IOS.md`](docs/IOS.md) for connecting the iPhone Files app.
+
+## CLI
+
+| Command | What it does |
+| --- | --- |
+| `synctwink init` | Write a config file (with a generated password). |
+| `synctwink install` | Full setup: deps, Syncthing folder/peers, WebDAV service, HTTPS. |
+| `synctwink serve` | Run the WebDAV server in the foreground (used by the service). |
+| `synctwink status` | Show Tailscale / WebDAV / Syncthing health + URLs. |
+| `synctwink info` | Print client connection details (for iOS Files etc.). |
+| `synctwink syncthing id` | Print this node's Syncthing device id. |
+| `synctwink syncthing pair <id>` | Add a peer and share the folder with it. |
+| `synctwink syncthing configure` | Re-apply folder + peers from config. |
+| `synctwink sync` | Wake Syncthing, pull/push now, re-quiet on battery (for laptops). |
+| `synctwink pause` / `synctwink resume` | Stop / start peer syncing. |
+| `synctwink service restart` | Restart the WebDAV service. |
+| `synctwink uninstall` | Remove the WebDAV service and reset `tailscale serve`. |
+
+For an **often-offline laptop** that wants offline files without burning
+battery, see [`docs/LAPTOP.md`](docs/LAPTOP.md): join it as a Syncthing peer,
+pause on battery, and use `synctwink sync` to pull changes on demand.
+
+## Configuration
+
+A single YAML file. Default location is `/etc/synctwink/config.yaml` (root) or
+`~/.config/synctwink/config.yaml`. Override with `--config` or `SYNCTWINK_CONFIG`.
+See [`synctwink/templates/config.example.yaml`](synctwink/templates/config.example.yaml).
+
+The config holds plaintext WebDAV passwords and is written `0600`. Because all
+traffic rides the encrypted tailnet, HTTP basic auth is safe here.
+
+## Requirements
+
+- Python 3.9+
+- Tailscale (installed + `tailscale up` already done)
+- Syncthing (auto-installed via `apt`/`dnf`/`pacman`/`brew` if missing)
+- A Linux host with `systemd`, or macOS with `launchd`
+
+## Architecture & design notes
+
+See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md).
+
+## License
+
+MIT — see [LICENSE](LICENSE).

synctwink-0.1.0/README.md

@@ -0,0 +1,120 @@
+# SyncTwink
+
+A skinny but powerful, self-hosted file sync across your devices over a [Tailscale](https://tailscale.com) tailnet.
+
+Two always-on servers (e.g. a **Raspberry Pi** and a **Mac Mini**) each expose
+the *same* folder over **WebDAV** for iOS Files and other clients, while
+**Syncthing** keeps the two copies replicated. Either server can go offline and
+your files stay reachable from the other.
+
+```
+        Tailnet (WireGuard, end-to-end encrypted)
+   ┌──────────────────────────────────────────────────┐
+   │                                                    │
+┌──┴──────────────┐   Syncthing replication   ┌─────────┴───────┐
+│  Raspberry Pi   │ <───────────────────────> │    Mac Mini     │
+│  • Tailscale    │                            │  • Tailscale    │
+│  • WebDAV :8080 │                            │  • WebDAV :8080 │
+│  • Syncthing    │                            │  • Syncthing    │
+└──┬──────────────┘                            └─────────┬───────┘
+   │                                                     │
+   │            WebDAV over Tailscale (HTTP/HTTPS)       │
+   └──────────────────────┬──────────────────────────────┘
+                          │
+            ┌─────────────┴─────────────┐
+            │  iPhone / iPad Files app  │  ← connects to whichever
+            │  Mac / other devices      │     server is reachable
+            └───────────────────────────┘
+```
+
+SyncTwink is the glue: a small Python package + CLI you install on **each
+server**. It configures the WebDAV service (via [WsgiDAV](https://wsgidav.readthedocs.io/)),
+sets up the Syncthing shared folder, and optionally fronts WebDAV with HTTPS
+using `tailscale serve`.
+
+## What it does
+
+- **WebDAV server** backed by WsgiDAV + cheroot, serving one folder with
+  per-user auth (basic + digest). Works with iOS Files, macOS Finder, and any
+  WebDAV client.
+- **Syncthing replication** between the two servers, configured for you via
+  Syncthing's REST API (adds the folder, pairs peers, enables file versioning).
+- **Native services** — installed as a `systemd` unit on Linux or a `launchd`
+  agent/daemon on macOS, so WebDAV starts on boot and restarts on failure.
+- **Tailscale-aware** — reads your tailnet status to print the right
+  connection URLs and can expose WebDAV over HTTPS with a valid MagicDNS cert.
+
+SyncTwink assumes Tailscale is already installed and `tailscale up` has been
+run on each machine. It does **not** manage the tailnet itself.
+
+## Quick start (run on *each* server)
+
+```bash
+# 1. Install the CLI (pick one)
+pipx install synctwink
+# or from source:
+# pipx install git+https://github.com/jchaselubitz/synctwink.git
+# pipx install .                  # from a git clone
+
+# 2. Create a config (generates a WebDAV password for you)
+sudo synctwink init --user jake --data-dir /srv/synctwink/data
+
+# 3. Find this machine's Syncthing device id (after Syncthing has run once)
+synctwink syncthing id
+```
+
+Put **each server's** device id into the **other server's** config under
+`syncthing.peers`, then on both machines:
+
+```bash
+sudo synctwink install     # installs deps, configures Syncthing, starts WebDAV
+synctwink status           # health check + connection URLs
+```
+
+See [`docs/INSTALL.md`](docs/INSTALL.md) for the full walkthrough and
+[`docs/IOS.md`](docs/IOS.md) for connecting the iPhone Files app.
+
+## CLI
+
+| Command | What it does |
+| --- | --- |
+| `synctwink init` | Write a config file (with a generated password). |
+| `synctwink install` | Full setup: deps, Syncthing folder/peers, WebDAV service, HTTPS. |
+| `synctwink serve` | Run the WebDAV server in the foreground (used by the service). |
+| `synctwink status` | Show Tailscale / WebDAV / Syncthing health + URLs. |
+| `synctwink info` | Print client connection details (for iOS Files etc.). |
+| `synctwink syncthing id` | Print this node's Syncthing device id. |
+| `synctwink syncthing pair <id>` | Add a peer and share the folder with it. |
+| `synctwink syncthing configure` | Re-apply folder + peers from config. |
+| `synctwink sync` | Wake Syncthing, pull/push now, re-quiet on battery (for laptops). |
+| `synctwink pause` / `synctwink resume` | Stop / start peer syncing. |
+| `synctwink service restart` | Restart the WebDAV service. |
+| `synctwink uninstall` | Remove the WebDAV service and reset `tailscale serve`. |
+
+For an **often-offline laptop** that wants offline files without burning
+battery, see [`docs/LAPTOP.md`](docs/LAPTOP.md): join it as a Syncthing peer,
+pause on battery, and use `synctwink sync` to pull changes on demand.
+
+## Configuration
+
+A single YAML file. Default location is `/etc/synctwink/config.yaml` (root) or
+`~/.config/synctwink/config.yaml`. Override with `--config` or `SYNCTWINK_CONFIG`.
+See [`synctwink/templates/config.example.yaml`](synctwink/templates/config.example.yaml).
+
+The config holds plaintext WebDAV passwords and is written `0600`. Because all
+traffic rides the encrypted tailnet, HTTP basic auth is safe here.
+
+## Requirements
+
+- Python 3.9+
+- Tailscale (installed + `tailscale up` already done)
+- Syncthing (auto-installed via `apt`/`dnf`/`pacman`/`brew` if missing)
+- A Linux host with `systemd`, or macOS with `launchd`
+
+## Architecture & design notes
+
+See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md).
+
+## License
+
+MIT — see [LICENSE](LICENSE).

synctwink-0.1.0/SyncTwink.egg-info/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.4
+Name: SyncTwink
+Version: 0.1.0
+Summary: A skinny but powerful, self-hosted file sync across your devices over a Tailscale tailnet.
+Author: Jake
+License: MIT
+Keywords: webdav,syncthing,tailscale,file-sync,self-hosted
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: WsgiDAV>=4.3.0
+Requires-Dist: cheroot>=10.0.0
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: requests>=2.28
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+# SyncTwink
+
+A skinny but powerful, self-hosted file sync across your devices over a [Tailscale](https://tailscale.com) tailnet.
+
+Two always-on servers (e.g. a **Raspberry Pi** and a **Mac Mini**) each expose
+the *same* folder over **WebDAV** for iOS Files and other clients, while
+**Syncthing** keeps the two copies replicated. Either server can go offline and
+your files stay reachable from the other.
+
+```
+        Tailnet (WireGuard, end-to-end encrypted)
+   ┌──────────────────────────────────────────────────┐
+   │                                                    │
+┌──┴──────────────┐   Syncthing replication   ┌─────────┴───────┐
+│  Raspberry Pi   │ <───────────────────────> │    Mac Mini     │
+│  • Tailscale    │                            │  • Tailscale    │
+│  • WebDAV :8080 │                            │  • WebDAV :8080 │
+│  • Syncthing    │                            │  • Syncthing    │
+└──┬──────────────┘                            └─────────┬───────┘
+   │                                                     │
+   │            WebDAV over Tailscale (HTTP/HTTPS)       │
+   └──────────────────────┬──────────────────────────────┘
+                          │
+            ┌─────────────┴─────────────┐
+            │  iPhone / iPad Files app  │  ← connects to whichever
+            │  Mac / other devices      │     server is reachable
+            └───────────────────────────┘
+```
+
+SyncTwink is the glue: a small Python package + CLI you install on **each
+server**. It configures the WebDAV service (via [WsgiDAV](https://wsgidav.readthedocs.io/)),
+sets up the Syncthing shared folder, and optionally fronts WebDAV with HTTPS
+using `tailscale serve`.
+
+## What it does
+
+- **WebDAV server** backed by WsgiDAV + cheroot, serving one folder with
+  per-user auth (basic + digest). Works with iOS Files, macOS Finder, and any
+  WebDAV client.
+- **Syncthing replication** between the two servers, configured for you via
+  Syncthing's REST API (adds the folder, pairs peers, enables file versioning).
+- **Native services** — installed as a `systemd` unit on Linux or a `launchd`
+  agent/daemon on macOS, so WebDAV starts on boot and restarts on failure.
+- **Tailscale-aware** — reads your tailnet status to print the right
+  connection URLs and can expose WebDAV over HTTPS with a valid MagicDNS cert.
+
+SyncTwink assumes Tailscale is already installed and `tailscale up` has been
+run on each machine. It does **not** manage the tailnet itself.
+
+## Quick start (run on *each* server)
+
+```bash
+# 1. Install the CLI (pick one)
+pipx install synctwink
+# or from source:
+# pipx install git+https://github.com/jchaselubitz/synctwink.git
+# pipx install .                  # from a git clone
+
+# 2. Create a config (generates a WebDAV password for you)
+sudo synctwink init --user jake --data-dir /srv/synctwink/data
+
+# 3. Find this machine's Syncthing device id (after Syncthing has run once)
+synctwink syncthing id
+```
+
+Put **each server's** device id into the **other server's** config under
+`syncthing.peers`, then on both machines:
+
+```bash
+sudo synctwink install     # installs deps, configures Syncthing, starts WebDAV
+synctwink status           # health check + connection URLs
+```
+
+See [`docs/INSTALL.md`](docs/INSTALL.md) for the full walkthrough and
+[`docs/IOS.md`](docs/IOS.md) for connecting the iPhone Files app.
+
+## CLI
+
+| Command | What it does |
+| --- | --- |
+| `synctwink init` | Write a config file (with a generated password). |
+| `synctwink install` | Full setup: deps, Syncthing folder/peers, WebDAV service, HTTPS. |
+| `synctwink serve` | Run the WebDAV server in the foreground (used by the service). |
+| `synctwink status` | Show Tailscale / WebDAV / Syncthing health + URLs. |
+| `synctwink info` | Print client connection details (for iOS Files etc.). |
+| `synctwink syncthing id` | Print this node's Syncthing device id. |
+| `synctwink syncthing pair <id>` | Add a peer and share the folder with it. |
+| `synctwink syncthing configure` | Re-apply folder + peers from config. |
+| `synctwink sync` | Wake Syncthing, pull/push now, re-quiet on battery (for laptops). |
+| `synctwink pause` / `synctwink resume` | Stop / start peer syncing. |
+| `synctwink service restart` | Restart the WebDAV service. |
+| `synctwink uninstall` | Remove the WebDAV service and reset `tailscale serve`. |
+
+For an **often-offline laptop** that wants offline files without burning
+battery, see [`docs/LAPTOP.md`](docs/LAPTOP.md): join it as a Syncthing peer,
+pause on battery, and use `synctwink sync` to pull changes on demand.
+
+## Configuration
+
+A single YAML file. Default location is `/etc/synctwink/config.yaml` (root) or
+`~/.config/synctwink/config.yaml`. Override with `--config` or `SYNCTWINK_CONFIG`.
+See [`synctwink/templates/config.example.yaml`](synctwink/templates/config.example.yaml).
+
+The config holds plaintext WebDAV passwords and is written `0600`. Because all
+traffic rides the encrypted tailnet, HTTP basic auth is safe here.
+
+## Requirements
+
+- Python 3.9+
+- Tailscale (installed + `tailscale up` already done)
+- Syncthing (auto-installed via `apt`/`dnf`/`pacman`/`brew` if missing)
+- A Linux host with `systemd`, or macOS with `launchd`
+
+## Architecture & design notes
+
+See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md).
+
+## License
+
+MIT — see [LICENSE](LICENSE).

synctwink-0.1.0/SyncTwink.egg-info/SOURCES.txt

@@ -0,0 +1,25 @@
+LICENSE
+README.md
+pyproject.toml
+SyncTwink.egg-info/PKG-INFO
+SyncTwink.egg-info/SOURCES.txt
+SyncTwink.egg-info/dependency_links.txt
+SyncTwink.egg-info/entry_points.txt
+SyncTwink.egg-info/requires.txt
+SyncTwink.egg-info/top_level.txt
+synctwink/__init__.py
+synctwink/__main__.py
+synctwink/cli.py
+synctwink/config.py
+synctwink/osutil.py
+synctwink/services.py
+synctwink/syncthing.py
+synctwink/tailscale.py
+synctwink/webdav.py
+synctwink/templates/config.example.yaml
+synctwink/templates/io.synctwink.battery.plist.tmpl
+synctwink/templates/io.synctwink.webdav.plist.tmpl
+synctwink/templates/stignore.example
+synctwink/templates/synctwink-webdav.service.tmpl
+tests/test_config.py
+tests/test_sync.py

synctwink-0.1.0/SyncTwink.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

synctwink-0.1.0/SyncTwink.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+synctwink = synctwink.cli:main

synctwink-0.1.0/SyncTwink.egg-info/requires.txt

@@ -0,0 +1,7 @@
+WsgiDAV>=4.3.0
+cheroot>=10.0.0
+PyYAML>=6.0
+requests>=2.28
+
+[dev]
+pytest>=7.0

synctwink-0.1.0/SyncTwink.egg-info/top_level.txt

@@ -0,0 +1 @@
+synctwink

synctwink-0.1.0/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "SyncTwink"
+version = "0.1.0"
+description = "A skinny but powerful, self-hosted file sync across your devices over a Tailscale tailnet."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+authors = [{ name = "Jake" }]
+keywords = ["webdav", "syncthing", "tailscale", "file-sync", "self-hosted"]
+
+dependencies = [
+    "WsgiDAV>=4.3.0",
+    "cheroot>=10.0.0",
+    "PyYAML>=6.0",
+    "requests>=2.28",
+]
+
+[project.scripts]
+synctwink = "synctwink.cli:main"
+
+[project.optional-dependencies]
+dev = ["pytest>=7.0"]
+
+[tool.setuptools]
+packages = ["synctwink"]
+
+[tool.setuptools.package-data]
+synctwink = ["templates/*"]

synctwink-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

synctwink-0.1.0/synctwink/__init__.py

@@ -0,0 +1,8 @@
+"""SyncTwink: personal cross-device file sync over a Tailscale tailnet.
+
+Two always-on servers (e.g. a Raspberry Pi and a Mac Mini) each expose the same
+folder over WebDAV (for iOS Files and ad-hoc clients) while Syncthing keeps the
+two copies replicated so either server can go offline without data loss.
+"""
+
+__version__ = "0.1.0"

synctwink-0.1.0/synctwink/__main__.py

@@ -0,0 +1,4 @@
+from synctwink.cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())