steilerdev/icloud-photos-sync repository overview

⁠

⁠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.

icloud-photos-sync is an independent project, and is not affiliated, endorsed, recommended by or otherwise affiliated with Apple Inc.

This 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⁠

Using the application through a simple and easy to use WebUI

• Checking the sync status
• Triggering ad-hoc sync
• Entering MFA code, when needed
• Receiving Push Notification about the synchronization status

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 (optional)

• Archiving an album will persist all assets in the respective folder in the local filesystem
• 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⁠. Additional documentation and further resources - including my personal use case / workflow⁠ - are published there as well.

⁠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⁠, in order for the file type to be added to the application.

Please also check out open and known issues⁠ and existing feature requests⁠ for more information.

⁠OS Support

⁠ ⁠ ⁠

⁠Contributing & Feedback

Please check the contributing guidelines⁠ to learn how to engage with this project.

⁠Acknowledgments

Special thanks to:

• @foxt⁠ for helping with reverse engineering the iCloud API (GSA⁠ & ADP⁠). Check out iCloud.js⁠, in case you need to access other aspects of iCloud.
• @konraddysput⁠ for help on the Backtrace integration.
• @timvahlbrock⁠ for their interest in this project and contributions in getting it updated.
• All current and past sponsors of this project.

⁠Release Workflow

⁠ ⁠ ⁠

⁠Monitoring Workflow

⁠