Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/steilerDev/icloud-photos-sync
One-way sync engine for the iCloud Photos Library into the native file system
https://github.com/steilerDev/icloud-photos-sync
icloud icloud-api icloud-backup icloud-photos icloud-sync photos
Last synced: 10 days ago
JSON representation
One-way sync engine for the iCloud Photos Library into the native file system
- Host: GitHub
- URL: https://github.com/steilerDev/icloud-photos-sync
- Owner: steilerDev
- License: gpl-3.0
- Created: 2022-01-10T16:05:40.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-22T07:56:08.000Z (5 months ago)
- Last Synced: 2024-11-05T14:19:25.471Z (10 days ago)
- Topics: icloud, icloud-api, icloud-backup, icloud-photos, icloud-sync, photos
- Language: TypeScript
- Homepage: https://icps.steiler.dev/
- Size: 7.21 MB
- Stars: 347
- Watchers: 9
- Forks: 8
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
iCloud Photos Sync
## Overview
This project provides a one-way sync engine for the iCloud Photos Library. The intention behind this project is to provide an easy way, to backup the full iCloud Photos Library to the native filesystem.
Currently, this can only be achieved, by having a Mac continuously run the *Photos.app* (with `Keep originals` enabled). With this method, the files cannot be easily viewed without the *Photos.app*.
This CLI Application offers the following high level functionality:
Continuously sync your complete remote iCloud Photos Library to your local file system efficiently
- iCloud Shared Photo Library support
- Support of MFA authentication through trusted devices, SMS and voice authentication - Security Key Support pending, please help out if you have this use case!
- Enable autonomous operation, by caching of MFA trust token
- Support of large libraries, through efficient diffing algorithm instead of full library pull
- Full iCloud Photos Library backup with all important files in their original state and edits - Live Photos support pending
Efficient handling of local state
- Each asset is only downloaded once and linked to its respective folders
- No need track local state in database, since state is completely reflected in filesystem (through naming & linking)
Archiving of folders
- All assets currently in the album will be persisted in the respective folder on the machine running icloud-photos-sync
- Future syncs will ignore the folder (so those assets will not be changed/deleted)
- If the remote album is moved, the archived folder will be moved to the same location
- If the remote album is deleted, the archived folder will be put into a 'lost+found' type of folder
- Optionally all photos from the archived folder can be deleted from the iCloud Photos Library, unless they are *Favorites* (reducing cloud storage needs)
Single purpose iCloud Photos application
- No reliance on full fledged third-party libraries that provide access to iCloud
- No configuration needed for continuous full backup
- Quicker support of use-case specific needs
## Documentation
A [*Get Started Guide* can be found on GH Pages](https://icps.steiler.dev/get-started/). Additional documentation and further resources - including my [personal use case / workflow](https://icps.steiler.dev/dev/motivation/) - are published there as well.
I am also trying to publish regular updates on the progress of this project in a [development blog](https://github.com/steilerDev/icloud-photos-sync/discussions/305).
## Limitations
As this application is using an undocumented public API, there are a couple of known limitations:
- **iCloud Shared Photo Library**:
While this app is syncing all assets from the *Shared Photo Library*, unfortunately the API does not provide the location of shared assets within the user's folder hierarchy (when navigating to a folder on the WebUI while having *Shared Photo Library* enabled will yield an error). Until this functionality is available, *Shared Photo Library* assets will only be present in the `_Shared-Photos` folder and therefore cannot be archived.
- **FileType Support**:
The support of file types needs to be hardcoded by this application, since a full list is not available or retrievable. If you come across an `Unknown filetype descriptor` error, [please report it](https://github.com/steilerDev/icloud-photos-sync/issues/143), in order for the file type to be added to the application.
Please also check out [open and known issues](https://github.com/steilerDev/icloud-photos-sync/issues?q=is%3Aopen+is%3Aissue+label%3Aclass%28bug%29%2Cclass%28improvement%29%2C%22class%28known+issue%29%22) and [existing feature requests](https://github.com/steilerDev/icloud-photos-sync/issues?q=is%3Aopen+is%3Aissue+label%3Aclass%28feature%29+label%3Astatus%28open%29%2Cstatus%28wontfix%29%2Cstatus%28backlog%29%2C%22status%28help+needed%29%22%2C%22status%28in+progress%29%22%2Cstatus%28investigating%29%2Cstatus%28previewed%29+) for more information.
## OS Support
## Contributing & Feedback
Please check the [contributing guidelines](https://github.com/steilerDev/icloud-photos-sync/blob/main/CONTRIBUTING.md) to learn how to engage with this project.
## Acknowledgments
- Special thanks to [@foxt](https://foxt.dev/) for helping with reverse engineering some tricky parts of the iCloud API ([GSA](https://github.com/steilerDev/icloud-photos-sync/issues/363) & [ADP](https://github.com/steilerDev/icloud-photos-sync/issues/202)) - check out his [iCloud.js](https://github.com/foxt/icloud.js) project in case you need to access other aspects of iCloud
### Release Workflow
### Monitoring Workflow
