From 80a35a3d01c09998990c8fe490bb87bbdac60ce4 Mon Sep 17 00:00:00 2001 From: Frank Steiler Date: Tue, 4 Jul 2023 16:43:38 +0200 Subject: [PATCH] docs: How to increase file limits Fixes #278 --- .vscode/icloud-photos-sync.cspell | 1 + CONTRIBUTING.md | 8 ++++---- docs/src/get-started.md | 12 ++++++++++++ 3 files changed, 17 insertions(+), 4 deletions(-) diff --git a/.vscode/icloud-photos-sync.cspell b/.vscode/icloud-photos-sync.cspell index e99c306c..cfb0372c 100644 --- a/.vscode/icloud-photos-sync.cspell +++ b/.vscode/icloud-photos-sync.cspell @@ -46,6 +46,7 @@ mockfs ncipollo Nerb Nfrb +nofile photoshop photoslibrary prerequest diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7715fd45..9dd2827c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,8 +27,7 @@ Instead, we recommend using [Github Discussions](https://github.com/steilerDev/i ## Found a Bug? -If you find a bug in the source code, you can help us by [submitting an issue](#submit-issue). -Even better, you can [submit a Pull Request](#submit-pr) with a fix. +If you find a bug in the application, you can help us by [submitting an issue](#submit-issue). Even better, you can [submit a Pull Request](#submit-pr) with a fix. ## Missing a Feature? @@ -48,11 +47,12 @@ If you would like to *implement* a new feature, please consider the size of the Before you submit an issue, please search the [issue tracker](https://github.com/steilerDev/icloud-photos-sync/issues). An issue for your problem might already exist and the discussion might inform you of workarounds readily available. -We want to fix all the issues as soon as possible, but before fixing a bug, we need to reproduce and confirm it. -In order to reproduce bugs, we require that you provide the error code displayed during runtime as well as the log file generated during the execution (preferably at `DEBUG` level). +We want to fix all the issues as soon as possible, but before fixing a bug, we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide the error code displayed during runtime as well as the log file generated during the execution (preferably at `DEBUG` level). You can file new issues by selecting from our [new issue templates](https://github.com/steilerDev/icloud-photos-sync/issues/new/choose) and filling out the issue template. +In case you are experiencing multiple issues, please make sure to open a separate issue for each of them, so we can properly track and address them! + ### Submitting a Pull Request (PR) diff --git a/docs/src/get-started.md b/docs/src/get-started.md index 4105c18d..cbe8a8ce 100644 --- a/docs/src/get-started.md +++ b/docs/src/get-started.md @@ -263,6 +263,9 @@ In order to perform a single synchronization execution, the [`sync` command](../ ``` docker exec -t photos-sync icloud-photos-sync sync ``` + + !!! tip "File limits" + Syncing a large library might fail due to reaching the maximum limit of open files. The `nofile` limit can be set [in the `docker-compose.yml`](https://docs.docker.com/compose/compose-file/05-services/#ulimits), but might require an increase of the [system limits](https://linuxhint.com/permanently_set_ulimit_value/). === "docker run" @@ -274,6 +277,9 @@ In order to perform a single synchronization execution, the [`sync` command](../ sync ``` + !!! tip "File limits" + Syncing a large library might fail due to reaching the maximum limit of open files. The `nofile` limit can be set through [a CLI argument](https://docs.docker.com/engine/reference/commandline/run/#ulimit), but might require an increase of the [system limits](https://linuxhint.com/permanently_set_ulimit_value/). + === "node" === "NPM" @@ -287,6 +293,9 @@ In order to perform a single synchronization execution, the [`sync` command](../ sync ``` + !!! tip "File limits" + Syncing a large library might fail due to reaching the maximum limit of open files. The `nofile` limit can be [increased temporarily or permanently](https://linuxhint.com/permanently_set_ulimit_value/). + === "From Source" ``` @@ -298,6 +307,9 @@ In order to perform a single synchronization execution, the [`sync` command](../ sync ``` + !!! tip "File limits" + Syncing a large library might fail due to reaching the maximum limit of open files. The `nofile` limit can be [increased temporarily or permanently](https://linuxhint.com/permanently_set_ulimit_value/). + ### Scheduled When using the [`daemon` command](../user-guides/cli/#daemon-command), the application will start scheduling synchronization executions based on the provided schedule.