nextcloud
/
desktop
mirror of https://github.com/nextcloud/desktop
0
0
Fork 0
Code Issues Releases Wiki Activity
desktop/doc/conffile.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

71 lines
7.7 KiB
ReStructuredText
Raw Normal View History

Build current documentation Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2018-01-29 00:15:00 +00:00
The Nextcloud Client reads a configuration file. You can locate this configuration file as follows:
moving description of config file and client optinos to own files. * split usage to three files: usage, conffile, options * fixing minor typos in mirall.1.rst and owncloud1.rst * owncloud.1 uses include conffile, options * mirall.1 uses include conffile, options * Fixes: #183
2013-02-09 11:23:32 +00:00
Fix owncloud man page formatting
2014-09-18 09:44:25 +00:00
On Linux distributions:
Build current documentation Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2018-01-29 00:15:00 +00:00
``$HOME/.config/Nextcloud/nextcloud.cfg``
moving description of config file and client optinos to own files. * split usage to three files: usage, conffile, options * fixing minor typos in mirall.1.rst and owncloud1.rst * owncloud.1 uses include conffile, options * mirall.1 uses include conffile, options * Fixes: #183
2013-02-09 11:23:32 +00:00
Fix owncloud man page formatting
2014-09-18 09:44:25 +00:00
On Microsoft Windows systems:
Build current documentation Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2018-01-29 00:15:00 +00:00
``%APPDATA%\Nextcloud\nextcloud.cfg``
moving description of config file and client optinos to own files. * split usage to three files: usage, conffile, options * fixing minor typos in mirall.1.rst and owncloud1.rst * owncloud.1 uses include conffile, options * mirall.1 uses include conffile, options * Fixes: #183
2013-02-09 11:23:32 +00:00
Fix owncloud man page formatting
2014-09-18 09:44:25 +00:00
On MAC OS X systems:
Build current documentation Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2018-01-29 00:15:00 +00:00
``$HOME/Library/Preferences/Nextcloud/nextcloud.cfg``
moving description of config file and client optinos to own files. * split usage to three files: usage, conffile, options * fixing minor typos in mirall.1.rst and owncloud1.rst * owncloud.1 uses include conffile, options * mirall.1 uses include conffile, options * Fixes: #183
2013-02-09 11:23:32 +00:00
Documentation update from Mark.
2014-06-25 20:04:33 +00:00
The configuration file contains settings using the Microsoft Windows .ini file
Build current documentation Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2018-01-29 00:15:00 +00:00
format. You can overwrite changes using the Nextcloud configuration dialog.
moving description of config file and client optinos to own files. * split usage to three files: usage, conffile, options * fixing minor typos in mirall.1.rst and owncloud1.rst * owncloud.1 uses include conffile, options * mirall.1 uses include conffile, options * Fixes: #183
2013-02-09 11:23:32 +00:00
Build current documentation Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2018-01-29 00:15:00 +00:00
.. note:: Use caution when making changes to the Nextcloud Client configuration
Documentation update from Mark.
2014-06-25 20:04:33 +00:00
file. Incorrect settings can produce unintended results.
moving description of config file and client optinos to own files. * split usage to three files: usage, conffile, options * fixing minor typos in mirall.1.rst and owncloud1.rst * owncloud.1 uses include conffile, options * mirall.1 uses include conffile, options * Fixes: #183
2013-02-09 11:23:32 +00:00
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?
2017-03-17 12:16:38 +00:00
Some interesting values that can be set on the configuration file are:
moving description of config file and client optinos to own files. * split usage to three files: usage, conffile, options * fixing minor typos in mirall.1.rst and owncloud1.rst * owncloud.1 uses include conffile, options * mirall.1 uses include conffile, options * Fixes: #183
2013-02-09 11:23:32 +00:00
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?
2017-03-17 12:16:38 +00:00
+----------------------------------------------------------------------------------------------------------------------------------------------------------+
Build current documentation Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2018-01-29 00:15:00 +00:00
| ``[Nextcloud]`` section |
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?
2017-03-17 12:16:38 +00:00
+=================================+===============+========================================================================================================+
| 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. |
+---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+
Local discovery: Use db instead of filesystem We mostly trust the file watchers meaning that we don't re-scan the local tree if we have done that recently and no file watcher events have arrived. If the file watchers invalidate a subtree, we rescan only that subtree. Since we're not entirely sure the file watchers are reliable, we still do full local discoveries regularly (1h by default). There is a config file setting as well as an environment variable to control the interval.
2017-09-14 14:43:23 +00:00
| ``fullLocalDiscoveryInterval`` | ``3600000`` | The interval after which the next synchronization will perform a full local discovery. |
+---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+
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?
2017-03-17 12:16:38 +00:00
| ``notificationRefreshInterval`` | ``300000`` | Specifies the default interval of checking for new server notifications in milliseconds. |
+---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+
moving description of config file and client optinos to own files. * split usage to three files: usage, conffile, options * fixing minor typos in mirall.1.rst and owncloud1.rst * owncloud.1 uses include conffile, options * mirall.1 uses include conffile, options * Fixes: #183
2013-02-09 11:23:32 +00:00
Doc: Add forceSyncInterval and timeout config file flags
2017-01-11 10:25:03 +00:00
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?
2017-03-17 12:16:38 +00:00
+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``[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. |
+---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+
- add description for moveToTrash variable
2018-01-25 14:05:26 +00:00
| ``moveToTrash`` | ``false`` | If non-locally deleted files should be moved to trash instead of deleting them completely. |
- doc: linux-only setting
2018-01-25 14:22:27 +00:00
| | | This option only works on linux |
- add description for moveToTrash variable
2018-01-25 14:05:26 +00:00
+---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+
Doc: Add forceSyncInterval and timeout config file flags
2017-01-11 10:25:03 +00:00
moving description of config file and client optinos to own files. * split usage to three files: usage, conffile, options * fixing minor typos in mirall.1.rst and owncloud1.rst * owncloud.1 uses include conffile, options * mirall.1 uses include conffile, options * Fixes: #183
2013-02-09 11:23:32 +00:00
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?
2017-03-17 12:16:38 +00:00
+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``[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. |
Local discovery: Use db instead of filesystem We mostly trust the file watchers meaning that we don't re-scan the local tree if we have done that recently and no file watcher events have arrived. If the file watchers invalidate a subtree, we rescan only that subtree. Since we're not entirely sure the file watchers are reliable, we still do full local discoveries regularly (1h by default). There is a config file setting as well as an environment variable to control the interval.
2017-09-14 14:43:23 +00:00
+---------------------------------+---------------+--------------------------------------------------------------------------------------------------------+