Skip to content

Commit

Permalink
docs: How to increase file limits
Browse files Browse the repository at this point in the history
Fixes #278
  • Loading branch information
steilerDev committed Jul 4, 2023
1 parent ce46f23 commit 80a35a3
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 4 deletions.
1 change: 1 addition & 0 deletions .vscode/icloud-photos-sync.cspell
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ mockfs
ncipollo
Nerb
Nfrb
nofile
photoshop
photoslibrary
prerequest
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ Instead, we recommend using [Github Discussions](https://github.com/steilerDev/i

## <a name="issue"></a> 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.


## <a name="feature"></a> Missing a Feature?
Expand All @@ -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!


### <a name="submit-pr"></a> Submitting a Pull Request (PR)

Expand Down
12 changes: 12 additions & 0 deletions docs/src/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand All @@ -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"
Expand All @@ -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"
```
Expand All @@ -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.
Expand Down

0 comments on commit 80a35a3

Please sign in to comment.