diff --git a/README.md b/README.md index afbd9869f..f88aa18a8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -# iCloud-docker +# iCloud-docker + [![CI - Main](https://github.com/mandarons/icloud-drive-docker/actions/workflows/ci-main-test-coverage-deploy.yml/badge.svg?branch=main)](https://github.com/mandarons/icloud-drive-docker/actions/workflows/ci-main-test-coverage-deploy.yml) [![Tests](https://mandarons.github.io/icloud-drive-docker/badges/tests.svg)](https://mandarons.github.io/icloud-drive-docker/test-results/) [![Coverage](https://mandarons.github.io/icloud-drive-docker/badges/coverage.svg)](https://mandarons.github.io/icloud-drive-docker/test-coverage/index.html) @@ -8,7 +9,7 @@ [![GitHub Sponsors][github-sponsors-badge]][github-sponsors] Buy Me A Coffee -🤟 __Please star this repository if you end up using this project. If it has improved your life in any way, consider donating to my mission using 'Sponsor' or 'Buy Me a Coffee' button. It will help me to continue supporting this product.__ :pray: +🤟 **Please star this repository if you end up using this project. If it has improved your life in any way, consider donating to my mission using 'Sponsor' or 'Buy Me a Coffee' button. It will help me to continue supporting this product.** :pray: iCloud-docker (previously known as iCloud-drive-docker) is a simple iCloud client in Docker environment. It uses [iCloudPy](https://github.com/mandarons/icloudpy) python library to interact with iCloud server. @@ -115,8 +116,8 @@ photos: all_albums: false # Optional, default false. If true preserve album structure. If same photo is in multpile albums creates duplicates on filesystem folder_format: "%Y/%m" # optional, if set put photos in subfolders according to format. Format cheatsheet - https://strftime.org filters: - # if all_albums is false list of albums to download, if all_albums is true list of ignored albums - # if empty and all_albums is false download all photos to "all" folder. if empty and all_albums is true download all folders + # if all_albums is false - albums list is used as filter-in, if all_albums is true - albums list is used as filter-out + # if albums list is empty and all_albums is false download all photos to "all" folder. if empty and all_albums is true download all folders albums: - "album 1" - "album2" @@ -124,14 +125,16 @@ photos: - "original" # - "medium" # - "thumb" - extensions: # Optional, media extensions to be included in syncing iCloud Photos content + extensions:# Optional, media extensions to be included in syncing iCloud Photos content # - jpg # - heic # - png ``` **_Note: On every sync, this client iterates all the files. Depending on number of files in your iCloud (drive + photos), syncing can take longer._** + ## Usage Policy + As mentioned in [USAGE.md](https://github.com/mandarons/icloud-drive-docker/blob/main/USAGE.md) [github-sponsors]: https://github.com/sponsors/mandarons diff --git a/config.yaml b/config.yaml index a360111e8..290d12289 100644 --- a/config.yaml +++ b/config.yaml @@ -48,8 +48,8 @@ photos: all_albums: false # Optional, default false. If true preserve album structure. If same photo is in multpile albums creates duplicates on filesystem # folder_format: "%Y/%m" # optional, if set put photos in subfolders according to format. Format cheatsheet - https://strftime.org filters: - # if all_albums is false list of albums to download, if all_albums is true list of ignored albums - # if empty and all_albums is false download all photos to "all" folder. if empty and all_albums is true download all folders + # if all_albums is false - albums list is used as filter-in, if all_albums is true - albums list is used as filter-out + # if albums list is empty and all_albums is false download all photos to "all" folder. if empty and all_albums is true download all folders albums: - "album 1" - "album2" diff --git a/tests/data/test_config.yaml b/tests/data/test_config.yaml index b3873f344..89112e28d 100644 --- a/tests/data/test_config.yaml +++ b/tests/data/test_config.yaml @@ -56,8 +56,8 @@ photos: all_albums: false # Optional, default false. If true preserve album structure. If same photo is in multpile albums creates duplicates on filesystem # folder_format: "%Y/%m" # optional, if set put photos in subfolders according to format. Format cheatsheet - https://strftime.org filters: - # if all_albums is false list of albums to download, if all_albums is true list of ignored albums - # if empty and all_albums is false download all photos to "all" folder. if empty and all_albums is true download all folders + # if all_albums is false - albums list is used as filter-in, if all_albums is true - albums list is used as filter-out + # if albums list is empty and all_albums is false download all photos to "all" folder. if empty and all_albums is true download all folders albums: - "album 2" - album-1