Skip to content

Commit

Permalink
Merge pull request #515 from dita-ot/pr/501-http-proxy-tweaks
Browse files Browse the repository at this point in the history
HTTP proxy revisions
  • Loading branch information
infotexture authored Dec 1, 2023
2 parents ea93f4f + 40ab609 commit 4590d7f
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 20 deletions.
11 changes: 7 additions & 4 deletions parameters/dita-command-arguments.dita
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,6 @@
</groupseq>
</fragment>
</syntaxdiagram>
<note type="tip">The <cmdname>dita install</cmdname> command uses a network connection for
installing and downloading content. In environments where an HTTP proxy is used to establish
a network connection, provide the proxy configuration via the <codeph>ANT_OPTS</codeph>
environment variable. For more information, see <cite>Configuring the proxy</cite>.</note>
<note type="attention">Prior to DITA-OT 3.5, subcommands were specified with the double-hyphen option syntax,
which is still supported for backwards compatibility. (For example, <cmdname>dita</cmdname>
<parmname>--install</parmname> will still work.)</note>
Expand Down Expand Up @@ -193,6 +189,13 @@
<pd>Install a single plug-in <varname>ID</varname> from the registry at
<xref keyref="site-plugin-registry"/> (or a local registry), from a remote <varname>URL</varname>, or a
local ZIP <varname>file</varname>.</pd>
<pd>
<note type="tip">The <cmdname>dita install</cmdname> command uses a network connection to install plug-ins
from the configured registry or process remote referenced resources. In environments where an HTTP proxy
is used to establish a network connection, you can provide the proxy configuration via the
<codeph>ANT_OPTS</codeph> environment variable. For more information, see
<xref keyref="configuring-proxies"/>.</note>
</pd>
</plentry>
<plentry>
<pt>
Expand Down
2 changes: 1 addition & 1 deletion resources/source-files.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<keydef keys="common-html-processing" href="../reference/common-html-processing.dita"/>
<keydef keys="configuration-properties" href="../parameters/configuration-properties.dita"/>
<keydef keys="configuration-properties-file" href="../parameters/configuration-properties-file.dita"/>
<keydef keys="configuring-the-proxy" href="../topics/configuring-the-proxy.dita"/>
<keydef keys="configuring-proxies" href="../topics/configuring-proxies.dita"/>
<keydef keys="conref-task" href="../resources/conref-task.dita"/>
<keydef keys="creating-an-ant-build-script" href="../topics/creating-an-ant-build-script.dita"/>
<keydef keys="creating-docker-images" href="../topics/creating-docker-images.dita"/>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
<!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
<task id="configuring-the-proxy">
<task id="configuring-proxies">
<title>Configuring the proxy</title>
<titlealts>
<navtitle>Configuring the proxy</navtitle>
</titlealts>
<shortdesc>Certain commands, for example, the <cmdname>dita install</cmdname> command, use a
network connection for installing and downloading content. In environments where an HTTP proxy
is used to establish a network connection, provide the proxy configuration via the
<shortdesc>Certain commands, for example, the <cmdname>dita install</cmdname> command, use a network connection to
install plug-ins from the configured registry or process remote referenced resources. In environments where an HTTP
proxy is used to establish a network connection, you can provide the proxy configuration via the
<codeph>ANT_OPTS</codeph> environment variable. </shortdesc>
<prolog>
<metadata>
Expand Down Expand Up @@ -44,19 +44,19 @@
</chhead>
<chrow platform="unix">
<choption>Linux or macOS&#xA0;</choption>
<chdesc><codeph>export ANT_OPTS="-Dhttp.proxySet=true \
-Dhttps.proxyHost=<varname>&lt;HTTPS proxy IP address></varname> \
-Dhttp.proxyHost=<varname>&lt;HTTP proxy IP address></varname> \
-Dhttp.proxyPort=<varname>&lt;HTTP proxy port></varname> \
-Dhttps.proxyPort=<varname>&lt;HTTPS proxy port></varname>"</codeph></chdesc>
<chdesc><codeblock outputclass="syntax-bash multi-platform">export ANT_OPTS="-Dhttp.proxySet=true \
-Dhttps.proxyHost=<varname>&lt;HTTPS proxy IP address></varname> \
-Dhttp.proxyHost=<varname>&lt;HTTP proxy IP address></varname> \
-Dhttp.proxyPort=<varname>&lt;HTTP proxy port></varname> \
-Dhttps.proxyPort=<varname>&lt;HTTPS proxy port></varname>"</codeblock></chdesc>
</chrow>
<chrow platform="windows">
<choption>Windows</choption>
<chdesc><codeph>set ANT_OPTS=%ANT_OPTS% -Dhttp.proxySet=true \
-Dhttps.proxyHost=<varname>&lt;HTTPS proxy IP address></varname> \
-Dhttp.proxyHost=<varname>&lt;HTTP proxy IP address></varname> \
-Dhttp.proxyPort=<varname>&lt;HTTP proxy port></varname> \
-Dhttps.proxyPort=<varname>&lt;HTTPS proxy port></varname></codeph></chdesc>
<chdesc><codeblock outputclass="syntax-bash multi-platform">set ANT_OPTS=%ANT_OPTS% -Dhttp.proxySet=true ^
-Dhttps.proxyHost=<varname>&lt;HTTPS proxy IP address></varname> ^
-Dhttp.proxyHost=<varname>&lt;HTTP proxy IP address></varname> ^
-Dhttp.proxyPort=<varname>&lt;HTTP proxy port></varname> ^
-Dhttps.proxyPort=<varname>&lt;HTTPS proxy port></varname></codeblock></chdesc>
</chrow>
</choicetable>
</step>
Expand Down
2 changes: 1 addition & 1 deletion topics/troubleshooting.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@
<topicref keyref="dita-command-help"/>
<topicref keyref="increasing-the-jvm"/>
<topicref keyref="reducing-processing-time"/>
<topicref keyref="configuring-the-proxy"/>
<topicref keyref="configuring-proxies"/>

</map>

0 comments on commit 4590d7f

Please sign in to comment.