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

Document the changes to DownloadInstrument

parent 21bfc18b
......@@ -26,6 +26,9 @@ UpdateInstrumentDefinitions.OnStartup = 1
UpdateInstrumentDefinitions.URL = https://api.github.com/repos/mantidproject/mantid/contents/instrument
This stores the url used to access the contents of the Mantid Instrument Definition Repository.
network.github.api_token = (not shown)
This overrides the github api token that is used by the algorithm. To use unauthenticated requests, set it to an empty string or the values ``unset``.
Output Messages
###############
......
......@@ -196,6 +196,10 @@ Network Properties
| ``network.scriptrepo.timeout`` |The timeout for network operations in the script | ``5`` |
| |repository, this overrides the default timeout. | |
+-------------------------------------------+---------------------------------------------------+---------------------------------+
| ``network.github.api_token`` |The api token for github calls used by | (not shown) |
| |``DownloadInstrument``. Setting this to ``unset`` | |
| |or an empty string will turn off authentication. | |
+-------------------------------------------+---------------------------------------------------+---------------------------------+
| ``proxy.host`` | Allows the system proxy to be overridden, if not | ``http://www.proxy.org`` |
| | set mantid will use the system proxy | |
+-------------------------------------------+---------------------------------------------------+---------------------------------+
......
......@@ -16,6 +16,7 @@ Concepts
- Added packing fraction to :ref:`Material <Materials>` to separate number density and effective number density.
- Added a feature allowing time-dependent values for individual instrument parameters.
- Added a ``PythonStdOutChannel`` and the ability to change the :ref:`logging channel <Properties File>` without restarting mantid framework
- Bugfix :ref:`DownloadInstrument <algm-DownloadInstrument>` to try unauthenticated connections if authenticated failes. Also added the ability to allow for setting the github api token in the :ref:`properties file <Properties File>`
Algorithms
----------
......
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