YuzuZensai/Zen-Sync
1
0
Fork 0
mirror of https://github.com/YuzuZensai/Zen-Sync.git synced 2026-09-13 10:49:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

📚 docs: Update README.md

Browse Source
This commit is contained in:
yuzu
2026-07-21 03:17:36 +07:00
committed by GitHub
parent 3310fb3f44
commit 995893d756
1 changed files with 36 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+36 -36
View File
@@ -2,7 +2,7 @@
A Windows only command-line tool for syncing [Zen Browser](https://zen-browser.app/) data with S3-compatible storage services. A Windows only command-line tool for syncing [Zen Browser](https://zen-browser.app/) data with S3-compatible storage services.
## 🤔 What it does ## What it does
Since Zen Browser doesn't have proper profile sync yet, this is my quick solution built in a few hours to keep my stuffs in sync across multiple machines. Since Zen Browser doesn't have proper profile sync yet, this is my quick solution built in a few hours to keep my stuffs in sync across multiple machines.
@@ -10,72 +10,72 @@ It backs up all the important stuff to any S3-compatible cloud storage so you ca
The default (customizable) setting skips session cookies, temporary storage, and other data because sites I visit can detect copied sessions through fingerprinting and will invalidate them. The default (customizable) setting skips session cookies, temporary storage, and other data because sites I visit can detect copied sessions through fingerprinting and will invalidate them.
## ✨ Features ## Features
- 🔄 **Bidirectional sync** between local and S3 storage - **Bidirectional sync** between local and S3 storage
- 🔍 **Filtering** - only syncs important files, excludes cache and temporary data - **Filtering** - only syncs important files, excludes cache and temporary data
- ⚡ **"Incremental" sync** - only uploads/downloads changed files - **"Incremental" sync** - only uploads/downloads changed files
- 🔗 **Custom S3 endpoints** - works with any S3-compatible service - **Custom S3 endpoints** - works with any S3-compatible service
## 📋 What gets synced by default ## 📋 What gets synced by default
**Included:** **Included:**
- 📁 Profile configuration (`profiles.ini`, `installs.ini`, `compatibility.ini`) - Profile configuration (`profiles.ini`, `installs.ini`, `compatibility.ini`)
- 🗃️ Profile Groups databases (`Profile Groups/*.sqlite`) - Profile Groups databases (`Profile Groups/*.sqlite`)
- 📚 Bookmarks (`places.sqlite`, `bookmarks.html`) - Bookmarks (`places.sqlite`, `bookmarks.html`)
- 🔒 Saved passwords and certificates (`key4.db`, `cert9.db`, `logins.json`) - Saved passwords and certificates (`key4.db`, `cert9.db`, `logins.json`)
- 🧩 Extensions and their settings (`extensions.json`, `extension-*.json`) - Extensions and their settings (`extensions.json`, `extension-*.json`)
- 🎨 Custom themes and CSS (`zen-*.json`, `zen-*.css`, `userChrome.css`, `userContent.css`) - Custom themes and CSS (`zen-*.json`, `zen-*.css`, `userChrome.css`, `userContent.css`)
- ⚙️ Browser preferences (`prefs.js`, `user.js`) - Browser preferences (`prefs.js`, `user.js`)
- 🔍 Search engine settings (`search.json.mozlz4`) - Search engine settings (`search.json.mozlz4`)
- 🖼️ Favicons (`favicons.sqlite`) - Favicons (`favicons.sqlite`)
- 📂 Chrome folder customizations (`chrome/**/*`) - Chrome folder customizations (`chrome/**/*`)
- 📔 and other files from customizable ruleset - and other files from customizable ruleset
**Excluded:** **Excluded:**
- 🗑️ Cache files (`cache2/*`, `thumbnails/*`, `shader-cache/*`) - Cache files (`cache2/*`, `thumbnails/*`, `shader-cache/*`)
- 📜 Logs and crash reports (`logs/*`, `crashes/*`, `minidumps/*`) - Logs and crash reports (`logs/*`, `crashes/*`, `minidumps/*`)
- 🔒 Lock files (`*.lock`, `*.lck`, `parent.lock`) - Lock files (`*.lock`, `*.lck`, `parent.lock`)
- 💾 Temporary storage (`storage/temporary/*`, `storage/*/ls/*`) - Temporary storage (`storage/temporary/*`, `storage/*/ls/*`)
- 📋 Session data (`sessionstore.jsonlz4`, `sessionCheckpoints.json`) - Session data (`sessionstore.jsonlz4`, `sessionCheckpoints.json`)
- 🍪 Session cookies (`cookies.sqlite*`) - Session cookies (`cookies.sqlite*`)
- 🛡️ Temporary browsing data (`webappsstore.sqlite*`, `safebrowsing/*`) - Temporary browsing data (`webappsstore.sqlite*`, `safebrowsing/*`)
Use `--help` with any command for detailed options. Use `--help` with any command for detailed options.
## 🚀 Quick Start ## Quick Start
1. ⚙️ **Configure your S3 settings:** 1. **Configure your S3 settings:**
```bash ```bash
python zensync.py configure --bucket your-bucket-name --endpoint-url https://your-s3-endpoint.com python zensync.py configure --bucket your-bucket-name --endpoint-url https://your-s3-endpoint.com
``` ```
or just run ```python zensync.py configure``` then edit the configuration json manually. or just run ```python zensync.py configure``` then edit the configuration json manually.
2. ⬆️ **Upload your profiles:** 2. **Upload your profiles:**
```bash ```bash
python zensync.py upload python zensync.py upload
``` ```
3. ⬇️ **Download profiles on another machine:** 3. **Download profiles on another machine:**
```bash ```bash
python zensync.py download python zensync.py download
``` ```
4. 🔄 **Two-way sync:** 4. **Two-way sync:**
```bash ```bash
python zensync.py sync python zensync.py sync
``` ```
## 🎮 Main Commands ## 🎮 Main Commands
- ⚙️ `configure` - Set up S3 credentials and paths - `configure` - Set up S3 credentials and paths
- ⬆️ `upload` - Backup profiles to S3 - `upload` - Backup profiles to S3
- ⬇️ `download` - Restore profiles from S3 - `download` - Restore profiles from S3
- 🔄 `sync` - Bidirectional synchronization - `sync` - Bidirectional synchronization
- 📋 `list-profiles` - Show available local profiles - `list-profiles` - Show available local profiles
- ℹ️ `profile-info` - Display profile system information - `profile-info` - Display profile system information
## 📝 Configuration ## Configuration
Settings are stored in `zen_sync_config.json`. Settings are stored in `zen_sync_config.json`.