File tree Expand file tree Collapse file tree 2 files changed +65
-1
lines changed Expand file tree Collapse file tree 2 files changed +65
-1
lines changed Original file line number Diff line number Diff line change @@ -113,4 +113,53 @@ The {+atlas-cli+} supports the following environment variables:
113
113
{+atlas-cli+}. Set to ``false`` to disable telemetry.
114
114
115
115
You can also enable or disable telemetry with ``DO_NOT_TRACK``,
116
- but you don't need to specify both.
116
+ but you don't need to specify both.
117
+
118
+ * - ``HTTP_PROXY``
119
+ - The absolute |url| or the hostname and port in the
120
+ ``hostname[:port]`` format.
121
+
122
+ .. example::
123
+
124
+ The following example shows how to set up the environment
125
+ variable if your proxy configuration doesn't require
126
+ authentication.
127
+
128
+ .. code-block:: sh
129
+ :copyable: false
130
+
131
+ HTTP_PROXY=<my.proxy.address>
132
+
133
+ The following example shows how to set up the environment
134
+ variable if your proxy configuration requires authentication.
135
+
136
+ .. code-block:: sh
137
+ :copyable: false
138
+
139
+ HTTP_PROXY=<username>:<password>@<my.proxy.address>
140
+
141
+ The following example shows how to set up the environment
142
+ variable if the scheme is ``socks5``.
143
+
144
+ .. code-block:: sh
145
+ :copyable: false
146
+
147
+ HTTP_PROXY=socks5://<my.proxy.address>
148
+
149
+ * - ``HTTPS_PROXY``
150
+ - The absolute |url|. If ``HTTP_PROXY`` is also set, this takes
151
+ precedence over ``HTTP_PROXY`` for all requests.
152
+
153
+ .. example::
154
+
155
+ The following example shows how to set up the environment
156
+ variable.
157
+
158
+ .. code-block:: sh
159
+ :copyable: false
160
+
161
+ HTTPS_PROXY=https://<my.proxy.address>
162
+
163
+ * - ``NO_PROXY``
164
+ - Indicates no proxy for the |url| because proxy isn't configured
165
+ for the |url|.
Original file line number Diff line number Diff line change @@ -103,6 +103,21 @@ Complete the Prerequisites
103
103
- Add your host's IP address to the :ref:`IP access list <access-list>`.
104
104
- If you select ``atlas config init`` as your connection method, you must
105
105
:ref:`Configure API keys <atlas-admin-api-access>`.
106
+ - If your {+atlas-cli+} installation is behind a
107
+ firewall and you want to use a proxy |url|,
108
+ set up the ``HTTP_PROXY`` or ``HTTPS_PROXY`` :ref:`environment
109
+ variable <atlas-cli-env-vars>`.
110
+
111
+ .. important::
112
+
113
+ {+atlas-cli+} supports
114
+ ``http``, ``https``, and ``socks5`` schemes. You must specify
115
+ ``cloud.mongodb.com/`` as the main target URL
116
+ in the proxy service's access list. You must also specify the
117
+ username and password if your proxy configuration enables authentication.
118
+
119
+ To learn more, see `Proxy server
120
+ <https://en.wikipedia.org/wiki/Proxy_server>`__.
106
121
107
122
Follow These Steps
108
123
~~~~~~~~~~~~~~~~~~
You can’t perform that action at this time.
0 commit comments