aboutsummaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorEven Rouault <even.rouault@spatialys.com>2019-12-25 20:13:03 +0100
committerEven Rouault <even.rouault@spatialys.com>2019-12-27 11:14:16 +0100
commit2093aca0720949303410280912b61efd791d2f01 (patch)
treea69c5392ed6689a88d9d959ddb41107413efacc6 /docs/source
parentc4589fbe42e5fea07a03919d3484164f5fb70dd3 (diff)
downloadPROJ-2093aca0720949303410280912b61efd791d2f01.tar.gz
PROJ-2093aca0720949303410280912b61efd791d2f01.zip
Network: make CDN endpoint configurable either in proj.ini, PROJ_NETWORK_ENDPOINT or proj_context_set_url_endpoint()
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/resource_files.rst24
-rw-r--r--docs/source/usage/environmentvars.rst9
2 files changed, 33 insertions, 0 deletions
diff --git a/docs/source/resource_files.rst b/docs/source/resource_files.rst
index 69cf2f95..ea02fd4b 100644
--- a/docs/source/resource_files.rst
+++ b/docs/source/resource_files.rst
@@ -54,6 +54,30 @@ A proj installation includes a SQLite database of transformation information
that must be accessible for the library to work properly. The library will
print an error if the database can't be found.
+proj.ini
+-------------------------------------------------------------------------------
+
+.. versionadded:: 7.0
+
+proj.ini is a text configuration file, mostly dedicated at setting up network
+related parameters.
+
+Its default content is:
+
+::
+
+ [general]
+ ; Lines starting by ; are commented lines.
+ ;
+
+ ; Network capabilities disabled by default.
+ ; Can be overriden with the PROJ_NETWORK=ON environment variable.
+ ; network = on
+
+ ; Can be overriden with the PROJ_NETWORK_ENDPOINT environment variable.
+ cdn_endpoint = https://cdn.proj.org
+
+
Transformation grids
-------------------------------------------------------------------------------
diff --git a/docs/source/usage/environmentvars.rst b/docs/source/usage/environmentvars.rst
index 00058716..24ae4a45 100644
--- a/docs/source/usage/environmentvars.rst
+++ b/docs/source/usage/environmentvars.rst
@@ -65,3 +65,12 @@ done by setting the variable with no content::
(Content Delivery Network) storage, when grids are not available locally.
Alternatively, the :c:func:`proj_context_set_enable_network` function can
be used.
+
+.. envvar:: PROJ_NETWORK_ENDPOINT
+
+ .. versionadded:: 7.0.0
+
+ Define the endpoint of the CDN storage. Normally defined through the proj.ini
+ configuration file locale in PROJ_LIB.
+ Alternatively, the :c:func:`proj_context_set_url_endpoint` function can
+ be used.