diff options
| author | Samuel Alfageme <samuel.alfageme@gmail.com> | 2017-03-17 15:16:38 +0300 |
|---|---|---|
| committer | Olivier Goffart <ogoffart@woboq.com> | 2017-03-20 13:55:02 +0300 |
| commit | d375e9b86cde0a847cbec88e7818eeb7292c483e (patch) | |
| tree | 7921fc772bf6ac31f112de3844dcc40617ed23f9 /doc/conffile.rst | |
| parent | 722918abd647f55fa7ceb2018103ca5ee11cce58 (diff) | |
Including some info on the proxy config. in the docs.
This was a request of @michaelstingl to document how to configure the proxy manually via the .cfg file for config provisioning purposes.
- Restructured the bullet points into 3 different tables; I believe it's a cleaner approach; maybe this is also applicable to other sections.
- Would be logical to include also settings on proxy auth?
Diffstat (limited to 'doc/conffile.rst')
| -rw-r--r-- | doc/conffile.rst | 54 |
1 files changed, 42 insertions, 12 deletions
diff --git a/doc/conffile.rst b/doc/conffile.rst index ce06aacb2..9b3c2ffe0 100644 --- a/doc/conffile.rst +++ b/doc/conffile.rst @@ -16,20 +16,50 @@ format. You can overwrite changes using the ownCloud configuration dialog. .. note:: Use caution when making changes to the ownCloud Client configuration file. Incorrect settings can produce unintended results. -You can change the following configuration settings in the ``[ownCloud]`` section: +Some interesting values that can be set on the configuration file are: -- ``remotePollInterval`` (default: ``30000``) -- Specifies the poll time for the remote repository in milliseconds. ++----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[ownCloud]`` section | ++=================================+===============+========================================================================================================+ +| Variable | Default | Meaning | ++---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+ +| ``remotePollInterval`` | ``30000`` | Specifies the poll time for the remote repository in milliseconds. | ++---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+ +| ``forceSyncInterval`` | ``7200000`` | The duration of no activity after which a synchronization run shall be triggered automatically. | ++---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+ +| ``notificationRefreshInterval`` | ``300000`` | Specifies the default interval of checking for new server notifications in milliseconds. | ++---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+ -- ``forceSyncInterval`` (default: ``7200000``) -- The duration of no activity after which a synchronization run shall be triggered automatically. -- ``notificationRefreshInterval`` (default: ``300000``) -- Specifies the default interval of checking for new server notifications in milliseconds. ++----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[General]`` section | ++=================================+===============+========================================================================================================+ +| Variable | Default | Meaning | ++---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+ +| ``chunkSize`` | ``5242880`` | Specifies the chunk size of uploaded files in bytes. | ++---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+ +| ``promptDeleteAllFiles`` | ``true`` | If a UI prompt should ask for confirmation if it was detected that all files and folders were deleted. | ++---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+ +| ``maxLogLines`` | ``20000`` | Specifies the maximum number of log lines displayed in the log window. | ++---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+ +| ``timeout`` | ``300`` | The timeout for network connections in seconds. | ++---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+ -You can change the following configuration settings in the ``[General]`` section: -- ``chunkSize`` (default: ``5242880``) -- Specifies the chunk size of uploaded files in bytes. - -- ``promptDeleteAllFiles`` (default: ``true``) -- If a UI prompt should ask for confirmation if it was detected that all files and folders were deleted. - -- ``maxLogLines`` (default: ``20000``) -- Specifies the maximum number of log lines displayed in the log window. - -- ``timeout`` (default: ``300``) -- The timeout for network connections in seconds. ++----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[Proxy]`` section | ++=================================+===============+========================================================================================================+ +| Variable | Default | Meaning | ++---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+ +| ``host`` | ``127.0.0.1`` | The address of the proxy server. | ++---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+ +| ``port`` | ``8080`` | The port were the proxy is listening. | ++---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+ +| ``type`` | ``2`` | ``0`` for System Proxy. | ++ + +--------------------------------------------------------------------------------------------------------+ +| | | ``1`` for SOCKS5 Proxy. | ++ + +--------------------------------------------------------------------------------------------------------+ +| | | ``2`` for No Proxy. | ++ + +--------------------------------------------------------------------------------------------------------+ +| | | ``3`` for HTTP(S) Proxy. | ++---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+
\ No newline at end of file |