Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[4.1] [PR 469] Clarify terms, query intervals and impacts #478

Merged
merged 10 commits into from
Jul 7, 2023
33 changes: 21 additions & 12 deletions modules/ROOT/pages/advanced_usage/configuration_file.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,29 +31,38 @@ WARNING: Use caution when making changes to the ownCloud Desktop App configurati

== Section `[ownCloud]`

[width="100%",cols="45%,25%,100%",options="header"]
See the xref:faq.adoc#clarification-of-terms-used[Clarification of Terms Used] for an in-depth explanation. Note that the default values are always set and used unless you change them.

[width="100%",cols="45%,^25%,100%",options="header"]
|===
| Variable | Default | Meaning
| Variable
| Default
| Meaning

| `remotePollInterval`
| `30000`
| Specifies the poll time for the remote repository in milliseconds.
| `30000` +
(30s)
| The interval in milliseconds after the last sync the Desktop app polls the server for changes. If not set explicitly via the Desktop app, the Desktop app queries the server if a server-side default is present.

| `forceSyncInterval`
| `7200000`
| The duration of no activity after which a synchronization run shall be triggered automatically.
| `7200000` +
(2h)
| The interval in milliseconds after which a synchronization is triggered automatically if no regular synchronization activity took place. This enforcement ensures that there is a mandatory synchronization independent of the server's polling response.

| `fullLocalDiscoveryInterval`
| `3600000`
| The interval after which the next synchronization will perform a full local discovery.
| `3600000` +
(1h)
| The interval in milliseconds after which the Desktop app will perform a full local discovery. Any changes found trigger a synchronization.

| `notificationRefreshInterval`
| `300000`
| Specifies the default interval of checking for new server notifications in milliseconds.
| `300000` +
(5min)
| The interval in milliseconds in which the Desktop app checks the server for new notifications.
|===

== Section `[General]`

[width="100%",cols="45%,25%,100%",options="header"]
[width="100%",cols="45%,^25%,100%",options="header"]
|===
| Variable | Default | Meaning

Expand Down Expand Up @@ -105,7 +114,7 @@ It does enable user interface options that can be used to opt in to experimental

== Section `[Proxy]`

[width="100%",cols="45%,25%,100%",options="header"]
[width="100%",cols="45%,^25%,100%",options="header"]
|===
| Variable
| Default
Expand Down
11 changes: 11 additions & 0 deletions modules/ROOT/pages/faq.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,17 @@

{description}

== Clarification of Terms Used

* *Polling* +
Polling is defined as the task where the Desktop app queries the server for changes - among other things. If the server responds with a change that had happened on the backend, the client will start syncing the changes after polling has finished.

* *Sync* +
Syncing is defined as the task where any changes will be synchronized, no matter if they occurred in the Desktop app or on the server side. Syncing does not depend on former polling while polling can result in a sync.

* *Local Discovery* +
Local discovery is defined as the task where the Desktop app looks for changes on the local filesystem. A local discovery can internally be enforced to check for changes that have been missed for example when the Desktop app was shut down during ongoing changes on the local filesystem. Any changes identified on the local filesystem trigger a sync after local discovery has finished.

== VFS for Windows Server

Without claim of completeness, actuality or support, Windows Server releases that are based on builds starting with 1709 should come with the native system API that is required to use VFS. Windows Servers 2016 and lower do not have native VFS included and will not be able to use VFS therefore.
Expand Down