Commit a924470e authored by Peterson, Peter's avatar Peterson, Peter
Browse files

Document more network properties

parent 2314d6ea
...@@ -8,14 +8,15 @@ The ``*.properties`` Files ...@@ -8,14 +8,15 @@ The ``*.properties`` Files
The Mantid framework is configured using up to three simple text ``*.properties`` files that are read an interpreted every time the framework is started. These properties are not the same as the properties of algorithms. All three have the same format. The three files are read from first to last, with the values in subsequent ``*.properties`` overriding those in previous ones. The Mantid framework is configured using up to three simple text ``*.properties`` files that are read an interpreted every time the framework is started. These properties are not the same as the properties of algorithms. All three have the same format. The three files are read from first to last, with the values in subsequent ``*.properties`` overriding those in previous ones.
1. ``/etc/mantid.local.properties`` is an optional, linux only file that sets shared defaults on a shared system. This is commonly used for setting the ``default.facility``, ``default.instrument``, and ``datasearch.searcharchive`` properties. 1. Install directory ``Mantid.properties`` defines the default configuration that the development team suggest as sensible defaults. This file should not be altered by users as it will be replaced with every new install or upgrade of Mantid.
2. Install directory ``Mantid.properties`` defines the default configuration that the development team suggest as sensible defaults. This file should not be altered by users as it will be replaced with every new install or upgrade of Mantid. 2. ``/etc/mantid.local.properties`` is an optional, linux only file that sets shared defaults on a shared system. This is commonly used for setting the ``default.facility``, ``default.instrument``, and ``datasearch.searcharchive`` properties.
3. Home directory ``Mantid.user.properties`` is where users may override any property setting in Mantid. Any Property setting in this file will override anything set in the ``Mantid.properties`` file. Simply either enter the property you wish to override in this file together with it's new value. The change will take effect the next time Mantid is started. Subsequent installs or upgrades of Mantid will never alter this file. 3. Home directory ``Mantid.user.properties`` is where users may override any property setting in Mantid. Any Property setting in this file will override anything set in the ``Mantid.properties`` file. Simply either enter the property you wish to override in this file together with it's new value. The change will take effect the next time Mantid is started. Subsequent installs or upgrades of Mantid will never alter this file.
The Properties The Properties
-------------- --------------
Note: Use forward slash (/) or double up on the number of backslash (\) characters for all paths .. note:: Use forward slash (``/``) or double up on the number of backslash (``\``) characters for all paths
General properties General properties
****************** ******************
...@@ -163,23 +164,37 @@ MantidPlot Properties ...@@ -163,23 +164,37 @@ MantidPlot Properties
Network Properties Network Properties
****************** ******************
+----------------------------------------+---------------------------------------------------+---------------------------------+ +-------------------------------------------+---------------------------------------------------+---------------------------------+
|Property |Description |Example value | |Property |Description |Example value |
+========================================+===================================================+=================================+ +===========================================+===================================================+=================================+
| ``network.default.timeout`` |Defines the default timeout for all network | ``30`` | | ``CheckMantidVersion.OnStartup`` | Check if there is a newer version available and | |
| |operations (in seconds). | | | | logs a message at ``information`` level | ``1`` |
+----------------------------------------+---------------------------------------------------+---------------------------------+ +-------------------------------------------+---------------------------------------------------+---------------------------------+
| ``network.scriptrepo.timeout`` |The timeout for network operations in the script | ``5`` | | ``network.default.timeout`` |Defines the default timeout for all network | ``30`` |
| |repository, this overrides the deafault timeout. | | | |operations (in seconds). | |
+----------------------------------------+---------------------------------------------------+---------------------------------+ +-------------------------------------------+---------------------------------------------------+---------------------------------+
| ``proxy.host`` | Allows the system proxy to be overridden, if not | ``http://www.proxy.org`` | | ``network.scriptrepo.timeout`` |The timeout for network operations in the script | ``5`` |
| | set mantid will use the system proxy | | | |repository, this overrides the deafault timeout. | |
+----------------------------------------+---------------------------------------------------+---------------------------------+ +-------------------------------------------+---------------------------------------------------+---------------------------------+
| ``proxy.port`` | Must be set if proxy.host is set | ``8080`` | | ``proxy.host`` | Allows the system proxy to be overridden, if not | ``http://www.proxy.org`` |
+----------------------------------------+---------------------------------------------------+---------------------------------+ | | set mantid will use the system proxy | |
| ``proxy.httpsTargetUrl`` | A sample url used to determine the system proxy to| ``http://www.google.com`` | +-------------------------------------------+---------------------------------------------------+---------------------------------+
| | use on windows. | | | ``proxy.port`` | Must be set if proxy.host is set | ``8080`` |
+----------------------------------------+---------------------------------------------------+---------------------------------+ +-------------------------------------------+---------------------------------------------------+---------------------------------+
| ``proxy.httpsTargetUrl`` | A sample url used to determine the system proxy to| ``http://www.google.com`` |
| | use on windows. | |
+-------------------------------------------+---------------------------------------------------+---------------------------------+
| ``UpdateInstrumentDefinitions.OnStartup`` | Download new instrument definition files and | |
| | ``Facilities.xml`` to ``~/.mantid/instruments`` | |
| | on linux or ``APPDATA`` directory on windows. If | |
| | this is disabled, previously downloaded | |
| | instruments are ignored and only those in the | |
| | installation are used. | ``1`` |
+-------------------------------------------+---------------------------------------------------+---------------------------------+
| ``usagereports.enabled`` | Enable usage reporting | ``1`` |
+-------------------------------------------+---------------------------------------------------+---------------------------------+
ScriptRepository Properties ScriptRepository Properties
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment