{"id":46610021,"url":"https://github.com/nicx17/immich_sync_app","last_synced_at":"2026-03-07T18:11:47.760Z","repository":{"id":341800646,"uuid":"1171538595","full_name":"nicx17/immich_sync_app","owner":"nicx17","description":"A daemon-based synchronization tool for uploading media files from a Linux desktop to an Immich server.","archived":false,"fork":false,"pushed_at":"2026-03-03T11:22:58.000Z","size":250,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-03T13:49:30.413Z","etag":null,"topics":["immich","immich-api","immich-integration","immichsync"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nicx17.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"roadmap.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-03T10:43:30.000Z","updated_at":"2026-03-03T11:23:02.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/nicx17/immich_sync_app","commit_stats":null,"previous_names":["nicx17/immich_sync_app"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/nicx17/immich_sync_app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicx17%2Fimmich_sync_app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicx17%2Fimmich_sync_app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicx17%2Fimmich_sync_app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicx17%2Fimmich_sync_app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nicx17","download_url":"https://codeload.github.com/nicx17/immich_sync_app/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicx17%2Fimmich_sync_app/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30225893,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T17:00:40.062Z","status":"ssl_error","status_checked_at":"2026-03-07T17:00:39.026Z","response_time":53,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["immich","immich-api","immich-integration","immichsync"],"created_at":"2026-03-07T18:11:46.850Z","updated_at":"2026-03-07T18:11:47.748Z","avatar_url":"https://github.com/nicx17.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Immich Auto-Sync for Linux\n\n\u003cdiv align=\"center\"\u003e\n\n\u003cimg src=\"src/assets/icon.png\" width=\"128\" alt=\"Immich Sync Logo\"\u003e\n\n![Status](https://img.shields.io/badge/Status-beta-FF90C3?style=for-the-badge)\n![GitHub Release](https://img.shields.io/github/v/release/nicx17/immich_sync_app?include_prereleases\u0026style=for-the-badge\u0026logo=github\u0026color=FF90C3)\n![Python](https://img.shields.io/badge/Python_3.10+-3776AB?style=for-the-badge\u0026logo=python\u0026logoColor=white)\n![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge\u0026logo=linux\u0026logoColor=black)\n![PySide6](https://img.shields.io/badge/PySide6-41CD52?style=for-the-badge\u0026logo=qt\u0026logoColor=white)\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-green.svg?style=for-the-badge)](https://www.gnu.org/licenses/gpl-3.0)\n\n\u003c/div\u003e\n\nA daemon-based synchronization tool for uploading media files from a Linux desktop to an [Immich](https://immich.app/) server.\n\nThis application monitors local directories (e.g., `~/Pictures`, `~/Videos`) for new files and automatically uploads them to your Immich instance. It runs as a background service and integrates with the desktop environment.\n\n\u003e [!NOTE]\n\u003e **This project is in BETA.** Core features are stable and tested. Please report any issues or edge cases you encounter.\n\n**Status:** Beta. Supports Immich v1.118+.\n\n## Screenshots\n\n| Settings Window | System Tray Menu |\n| :---: | :---: |\n| ![Settings Window](docs/screenshots/settings_window.png) | ![System Tray Menu](docs/screenshots/tray_icon_screenshot.png) |\n| **Ping Test Dialog** | **About Dialog** |\n| ![Ping Test Dialog](docs/screenshots/ping_test_screenshot.png) | ![About Dialog](docs/screenshots/about_dialog.png) |\n\n## Features\n\n- **File Monitoring**: Uses `inotify` to detect new files.\n- **Concurrent Uploads**: Uses multiple threads (10 workers) to process uploads.\n- **Offline Reliability**: Uploads that drop mid-flight or queue without a connection are serialized to a local cache. They safely wait out offline statuses (or a total computer reboot) and resume pushing via background workers seamlessly dynamically updating progress meters.\n- **Connectivity**: Automatically switches between **Internal (LAN)** and **External (WAN)** URLs based on availability with Captive Portal verification logic. You can selectively disable/enable these endpoints through UI toggles.\n- **Custom Album Mapping**: Select an existing remote Immich album, type a custom album name to create, or let the app automatically create albums based on the local folder name (e.g., `~/Pictures/Vacation 2024` -\u003e Album \"Vacation 2024\").\n- **One-Way Sync**: Uploads media without modifying local files.\n- **Security**: Stores the API Key in the system keyring (libsecret/KWallet).\n- **Desktop Integration**:\n  - **System Tray Icon**: Access to settings and status.\n  - **Wayland Support**: Tested on GNOME Wayland (requires AppIndicator support).\n\n## Installation\n\n### Method 1: AppImage (Recommended)\n\nThe easiest way to install Immich Sync is via the standalone AppImage, which includes all dependencies out-of-the-box.\n\n1. Go to the [Releases page](https://github.com/nicx17/immich_sync_app/releases) and download the latest `Immich_Sync-x86_64.AppImage`.\n2. Make it executable:\n\n   ```bash\n   chmod +x Immich_Sync-*.AppImage\n   ```\n\n3. Run it, or use the provided integration script to strictly install it to your Application Launcher menu:\n\n   ```bash\n   # Optional: Download and run the install script from the repo to set up the .desktop file and systemd auto-start\n   ./install-appimage.sh /path/to/downloaded/Immich_Sync-x86_64.AppImage\n   ```\n\n### Method 2: Manual / From Source\n\nIf you prefer not to use the AppImage, you can run the app directly from source.\n\n#### Prerequisites\n\n- Python 3.10+\n- `gobject-introspection` (for system tray support)\n- `libnotify` (optional)\n\n**Ubuntu/Debian:**\n\n```bash\nsudo apt install python3-pip python3-venv libgirepository1.0-dev libcairo2-dev gir1.2-gtk-3.0 gir1.2-appindicator3-0.1\n```\n\n**Fedora:**\n\n```bash\nsudo dnf install python3-pip python3-gobject gtk3 libappindicator-gtk3\n```\n\n**Arch Linux:**\n\n```bash\nsudo pacman -S python-pip python-gobject gtk3 libappindicator-gtk3\n```\n\n### Setup\n\n1. **Clone the Repository:**\n\n    ```bash\n    git clone https://github.com/yourusername/immich-sync-app.git\n    cd immich-sync-app\n    ```\n\n2. **Create a Virtual Environment:**\n\n    ```bash\n    python3 -m venv .venv\n    source .venv/bin/activate\n    ```\n\n3. **Install Dependencies:**\n\n    ```bash\n    pip install -r requirements.txt\n    ```\n\n## Usage\n\n### 1. Launch the Application\n\nRun the main script to start the background daemon and the system tray icon.\n\n```bash\nsource .venv/bin/activate\npython src/main.py\n```\n\n### 2. Configuration\n\nThe first run will open the **Settings Window** (or right-click the tray icon and select \"Settings\").\n\n1. **Internal URL**: LAN address (e.g., `http://192.168.1.50:2283`). This can be toggled on/off.\n2. **External URL**: WAN/Public address (e.g., `https://photos.example.com`). This can be toggled on/off.\n3. **API Key**: Generate in Immich Web UI (Account Settings \u003e API Keys). Needs **Asset** (Read/Create) and **Album** (Read/Create/Update) permissions.\n4. **Watch Paths**: Add local folders to sync.\n\n### 3. Automatic Start (Systemd)\n\nTo start automatically on login:\n\n1. Copy the service file:\n\n    ```bash\n    mkdir -p ~/.config/systemd/user/\n    cp setup/immich-sync.service ~/.config/systemd/user/\n    ```\n\n2. Edit the service file (`~/.config/systemd/user/immich-sync.service`) to update the path to the python executable and script location.\n3. Enable and start the service:\n\n    ```bash\n    systemctl --user enable --now immich-sync\n    ```\n\n## Documentation\n\nFor detailed guides, please refer to:\n\n- [Architecture Overview](docs/ARCHITECTURE.md)\n- [Configuration Guide](docs/CONFIGURATION.md)\n- [Troubleshooting](docs/TROUBLESHOOTING.md)\n- [Development Guide](docs/DEVELOPMENT.md)\n\n## Contributing\n\nPull requests are welcome. Check `roadmap.md` for planned features.\n\n## Acknowledgments\n\n- Application icon illustration by [Round Icons](https://unsplash.com/@roundicons?utm_source=unsplash\u0026utm_medium=referral\u0026utm_content=creditCopyText) on [Unsplash](https://unsplash.com/illustrations/a-white-and-orange-flower-on-a-white-background-IkQ_WrJzZOM?utm_source=unsplash\u0026utm_medium=referral\u0026utm_content=creditCopyText).\n\n## License\n\nGPLv3 License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnicx17%2Fimmich_sync_app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnicx17%2Fimmich_sync_app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnicx17%2Fimmich_sync_app/lists"}