Skip to content

Commit

Permalink
docs: Adding ADP information
Browse files Browse the repository at this point in the history
  • Loading branch information
@steilerDev
steilerDev committed Nov 24, 2023
1 parent 96de00c commit f14afe0
Show file tree
Hide file tree
Showing 6 changed files with 66 additions and 33 deletions.
2 changes: 2 additions & 0 deletions .vscode/icloud-photos-sync.cspell
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ pano
parens
photoshop
photoslibrary
photoview
polystat
postbuild
prerequest
Expand Down Expand Up @@ -112,6 +113,7 @@ typedoc
udse
upterm
uptermd
viktorstrate
vivaxy
Vvye
vyas
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,10 @@ This CLI Application offers the following high level functionality:
</details>

<details>
<summary><i>Archiving of folders</i></summary>
<summary><i>Archiving of folders (optional)</i></summary>
<p>
<ul>
<li>All assets currently in the album will be persisted in the respective folder on the machine running icloud-photos-sync</li>
<li>Archiving an album will persist all assets in the respective folder in the local filesystem</li>
<li>Future syncs will ignore the folder (so those assets will not be changed/deleted)</li>
<li>If the remote album is moved, the archived folder will be moved to the same location</li>
<li>If the remote album is deleted, the archived folder will be put into a 'lost+found' type of folder</li>
Expand Down
68 changes: 39 additions & 29 deletions docs/grafana/icloud-photos-sync.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -168,79 +168,84 @@
"index": 12,
"text": "MFA Required"
},
"PCS_REQUIRED": {
"PCS_NOT_READY": {
"color": "yellow",
"index": 13,
"text": "PCS Cookies not available yet"
},
"PCS_REQUIRED": {
"color": "yellow",
"index": 14,
"text": "PCS Cookies Required"
},
"SCHEDULED": {
"color": "super-light-green",
"index": 14,
"index": 15,
"text": "Run scheduled"
},
"SCHEDULED_FAILURE": {
"color": "red",
"index": 15,
"index": 16,
"text": "Scheduled Run Failed"
},
"SCHEDULED_OVERRUN": {
"color": "yellow",
"index": 17,
"index": 18,
"text": "Scheduled Overrun"
},
"SCHEDULED_SUCCESS": {
"color": "semi-dark-green",
"index": 16,
"index": 17,
"text": "Scheduled Run Succeeded"
},
"SESSION_EXPIRED": {
"color": "orange",
"index": 18,
"index": 19,
"text": "Session Expired"
},
"SYNC_COMPLETED": {
"color": "green",
"index": 19,
"index": 20,
"text": "Sync Completed"
},
"SYNC_RETRY": {
"color": "orange",
"index": 20,
"index": 21,
"text": "Sync Retrying"
},
"SYNC_START": {
"color": "yellow",
"index": 21,
"index": 22,
"text": "Sync Started"
},
"WRITE_ALBUMS_COMPLETED": {
"color": "yellow",
"index": 22,
"index": 23,
"text": "Album Write Completed"
},
"WRITE_ALBUMS_STARTED": {
"color": "yellow",
"index": 23,
"index": 24,
"text": "Album Write Started"
},
"WRITE_ASSETS_COMPLETED": {
"color": "yellow",
"index": 24,
"index": 25,
"text": "Asset Write Completed"
},
"WRITE_ASSETS_STARTED": {
"color": "yellow",
"index": 25,
"index": 26,
"text": "Asset Write Started"
},
"WRITE_COMPLETED": {
"color": "yellow",
"index": 26,
"index": 27,
"text": "Write Completed"
},
"WRITE_STARTED": {
"color": "yellow",
"index": 27,
"index": 28,
"text": "Write Started"
}
},
Expand Down Expand Up @@ -467,79 +472,84 @@
"index": 12,
"text": "MFA Required"
},
"PCS_NOT_READY": {
"color": "yellow",
"index": 14,
"text": "PCS Cookies not available yet"
},
"PCS_REQUIRED": {
"color": "yellow",
"index": 13,
"text": "PCS Cookies Required"
},
"SCHEDULED": {
"color": "super-light-green",
"index": 14,
"index": 15,
"text": "Run scheduled"
},
"SCHEDULED_FAILURE": {
"color": "red",
"index": 15,
"index": 16,
"text": "Scheduled Run Failed"
},
"SCHEDULED_OVERRUN": {
"color": "yellow",
"index": 17,
"index": 18,
"text": "Scheduled Overrun"
},
"SCHEDULED_SUCCESS": {
"color": "semi-dark-green",
"index": 16,
"index": 17,
"text": "Scheduled Run Succeeded"
},
"SESSION_EXPIRED": {
"color": "orange",
"index": 18,
"index": 19,
"text": "Session Expired"
},
"SYNC_COMPLETED": {
"color": "green",
"index": 19,
"index": 20,
"text": "Sync Completed"
},
"SYNC_RETRY": {
"color": "orange",
"index": 20,
"index": 21,
"text": "Sync Retrying"
},
"SYNC_START": {
"color": "yellow",
"index": 21,
"index": 22,
"text": "Sync Started"
},
"WRITE_ALBUMS_COMPLETED": {
"color": "yellow",
"index": 22,
"index": 23,
"text": "Album Write Completed"
},
"WRITE_ALBUMS_STARTED": {
"color": "yellow",
"index": 23,
"index": 24,
"text": "Album Write Started"
},
"WRITE_ASSETS_COMPLETED": {
"color": "yellow",
"index": 24,
"index": 25,
"text": "Asset Write Completed"
},
"WRITE_ASSETS_STARTED": {
"color": "yellow",
"index": 25,
"index": 26,
"text": "Asset Write Started"
},
"WRITE_COMPLETED": {
"color": "yellow",
"index": 26,
"index": 27,
"text": "Write Completed"
},
"WRITE_STARTED": {
"color": "yellow",
"index": 27,
"index": 28,
"text": "Write Started"
}
},
Expand Down
1 change: 1 addition & 0 deletions docs/mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ nav:
- 'User Guides':
- 'CLI Reference': user-guides/cli.md
- 'Common Warnings': user-guides/common-warnings.md
- 'Advanced Data Protection': user-guides/adp.md
- 'Sync Metrics': user-guides/sync-metrics.md
- 'Error & Crash Reporting': user-guides/error-reporting.md
- 'Security': user-guides/security.md
Expand Down
13 changes: 11 additions & 2 deletions docs/src/get-started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The `latest` tag should always represent the latest stable release, whereas the
Docker images are available on [DockerHub](https://hub.docker.com/r/steilerdev/icloud-photos-sync). Alternatively the docker image tar archive is available from the [Github releases](https://github.com/steilerDev/icloud-photos-sync/releases) and can be installed using `docker load --input <fileName>`

!!! tip "ARM Support"
The Docker image is also build for the arm64 platform (however [publishing this version is not possible through the current CI setup](https://github.com/docker/buildx/issues/1152)). The tar archive of the arm64 build of this image is available from the [Github releases](https://github.com/steilerDev/icloud-photos-sync/releases) and can be loaded using `docker load --input <fileName>`.
The Docker image is also build for the arm64 platform (however [publishing this version is not possible through the current CI setup](https://github.com/docker/buildx/issues/1152)). The tar archive of the arm64 build of this image is available from the [Github releases](https://github.com/steilerDev/icloud-photos-sync/releases) and can be loaded using `docker load --input <fileName>`.

=== "docker compose"
Expand Down Expand Up @@ -425,6 +425,15 @@ In order to archive an album, the [`archive` command](../user-guides/cli/#archiv
</path/to/your/local/library>/<path/to/album>
```

## Additional resources

- Monitor the tool through [sync metrics](../user-guides/sync-metrics/)
- Consult the [common warnings](../user-guides/common-warnings) in case any pop up
- Read about the requirements for supporting accounts with [Advanced Data Protection](../user-guides/adp/)
- Access your photo library locally through a [web UI](../user-guides/web-ui/)

## 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. The document outlines the bug reporting, feature and support request process for this tool.
Please check the [contributing guidelines](https://github.com/steilerDev/icloud-photos-sync/blob/main/CONTRIBUTING.md) to learn how to engage with this project. The document outlines the bug reporting, feature and support request process for this tool.

Consider supporting the development efforts by [sponsoring the author](https://github.com/sponsors/steilerDev).
11 changes: 11 additions & 0 deletions docs/src/user-guides/adp.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Advanced Data Protection

The following requirements need to be met in order to enable Advanced Data Protection for your iCloud account, while being able to use this tool:

- [Fulfill ADP requirements](https://support.apple.com/en-gb/HT212520#:~:text=known%20to%20Apple.-,Requirements,-To%20turn%20on)
- Enable MFA
- Create Backup Method (security key or recovery contact)
- [Enable ADP](https://support.apple.com/en-gb/HT212520#:~:text=Advanced%20Data%20Protection.-,How%20to%20turn%20on%20Advanced%20Data%20Protection%20for%20iCloud,-You%20can%20turn)
- [Turn on Web Access for iCloud Data](https://support.apple.com/en-gb/HT212520#:~:text=Web%20access%20to%20your%20data%20at%20iCloud.com)

The tool will send an authorization request to the trusted devices of the user before being able to access the iCloud data. If this does not happen within five minutes, the setup will timeout and the execution will fail. Currently metadata needs to be updated every 60 minutes, which will lead to a re-authentication and therefore the requirement to manually re-authorize of the data access.

0 comments on commit f14afe0

Please sign in to comment.