From 96fc2b4faf1606dbc59df146de8f221c43062f88 Mon Sep 17 00:00:00 2001 From: Edit Koselak Date: Thu, 5 Oct 2023 10:20:00 +0200 Subject: [PATCH 1/4] Explaining how to set up HTTP proxy for dita command Signed-off-by: Edit Koselak --- parameters/dita-command-arguments.dita | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/parameters/dita-command-arguments.dita b/parameters/dita-command-arguments.dita index cfe25873d..8d214b717 100644 --- a/parameters/dita-command-arguments.dita +++ b/parameters/dita-command-arguments.dita @@ -107,6 +107,11 @@ +

The dita 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 to the ANT_OPTS + environmental + variable:ANT_OPTS='-Dhttp.proxySet=true -Dhttps.proxyHost=<HTTPS proxy IP address> -Dhhtp.proxyHost=<HTTP proxy IP address> -Dhttp.proxyPort=<HTTP proxy port> -Dhttps.proxyPort=<HTTPS proxy port>' dita install <plug-in>

Prior to DITA-OT 3.5, subcommands were specified with the double-hyphen option syntax, which is still supported for backwards compatibility. (For example, dita --install will still work.) From d8ef884bf286005c4cd2be8ec08535b7d55c4b61 Mon Sep 17 00:00:00 2001 From: EditKoselak <61583300+EditKoselak@users.noreply.github.com> Date: Thu, 12 Oct 2023 10:08:08 +0200 Subject: [PATCH 2/4] Update parameters/dita-command-arguments.dita Co-authored-by: Roger Sheen Signed-off-by: EditKoselak <61583300+EditKoselak@users.noreply.github.com> --- parameters/dita-command-arguments.dita | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/parameters/dita-command-arguments.dita b/parameters/dita-command-arguments.dita index 8d214b717..749408e11 100644 --- a/parameters/dita-command-arguments.dita +++ b/parameters/dita-command-arguments.dita @@ -107,11 +107,14 @@ -

The dita 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 to the ANT_OPTS - environmental - variable:ANT_OPTS='-Dhttp.proxySet=true -Dhttps.proxyHost=<HTTPS proxy IP address> -Dhhtp.proxyHost=<HTTP proxy IP address> -Dhttp.proxyPort=<HTTP proxy port> -Dhttps.proxyPort=<HTTPS proxy port>' dita install <plug-in>

+

The dita 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 ANT_OPTS environment variable:ANT_OPTS='-Dhttp.proxySet=true -Dhttps.proxyHost=<HTTPS proxy IP address> -Dhttp.proxyHost=<HTTP proxy IP address> -Dhttp.proxyPort=<HTTP proxy port> -Dhttps.proxyPort=<HTTPS proxy port>' dita install <plug-in>

Prior to DITA-OT 3.5, subcommands were specified with the double-hyphen option syntax, which is still supported for backwards compatibility. (For example, dita --install will still work.) From 9c93019b862055088a65d4d94999493914ef365d Mon Sep 17 00:00:00 2001 From: Edit Koselak Date: Thu, 12 Oct 2023 10:53:07 +0200 Subject: [PATCH 3/4] Adding line breaks to long code block Signed-off-by: Edit Koselak --- parameters/dita-command-arguments.dita | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/parameters/dita-command-arguments.dita b/parameters/dita-command-arguments.dita index 749408e11..42acaaa55 100644 --- a/parameters/dita-command-arguments.dita +++ b/parameters/dita-command-arguments.dita @@ -107,14 +107,15 @@ -

The dita 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 ANT_OPTS environment variable:ANT_OPTS='-Dhttp.proxySet=true -Dhttps.proxyHost=<HTTPS proxy IP address> -Dhttp.proxyHost=<HTTP proxy IP address> -Dhttp.proxyPort=<HTTP proxy port> -Dhttps.proxyPort=<HTTPS proxy port>' dita install <plug-in>

+

The dita 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 ANT_OPTS + environment variable:ANT_OPTS="-Dhttp.proxySet=true \ +-Dhttps.proxyHost=<HTTPS proxy IP address> \ +-Dhttp.proxyHost=<HTTP proxy IP address> \ +-Dhttp.proxyPort=<HTTP proxy port> \ +-Dhttps.proxyPort=<HTTPS proxy port>" dita install <plug-in>

Prior to DITA-OT 3.5, subcommands were specified with the double-hyphen option syntax, which is still supported for backwards compatibility. (For example, dita --install will still work.) From 51fd8c775b93e086f0069426c9fafa4242043cc4 Mon Sep 17 00:00:00 2001 From: Edit Koselak Date: Thu, 30 Nov 2023 12:42:34 +0100 Subject: [PATCH 4/4] moving http proxy setting to separate topic Signed-off-by: Edit Koselak --- parameters/dita-command-arguments.dita | 13 ++--- resources/source-files.ditamap | 1 + topics/configuring-the-proxy.dita | 74 ++++++++++++++++++++++++++ topics/troubleshooting.ditamap | 1 + 4 files changed, 80 insertions(+), 9 deletions(-) create mode 100644 topics/configuring-the-proxy.dita diff --git a/parameters/dita-command-arguments.dita b/parameters/dita-command-arguments.dita index 42acaaa55..5eaa5332c 100644 --- a/parameters/dita-command-arguments.dita +++ b/parameters/dita-command-arguments.dita @@ -107,15 +107,10 @@ -

The dita 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 ANT_OPTS - environment variable:ANT_OPTS="-Dhttp.proxySet=true \ --Dhttps.proxyHost=<HTTPS proxy IP address> \ --Dhttp.proxyHost=<HTTP proxy IP address> \ --Dhttp.proxyPort=<HTTP proxy port> \ --Dhttps.proxyPort=<HTTPS proxy port>" dita install <plug-in>

+ The dita install 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 ANT_OPTS + environment variable. For more information, see Configuring the proxy. Prior to DITA-OT 3.5, subcommands were specified with the double-hyphen option syntax, which is still supported for backwards compatibility. (For example, dita --install will still work.) diff --git a/resources/source-files.ditamap b/resources/source-files.ditamap index 539166909..813e027d0 100644 --- a/resources/source-files.ditamap +++ b/resources/source-files.ditamap @@ -18,6 +18,7 @@ + diff --git a/topics/configuring-the-proxy.dita b/topics/configuring-the-proxy.dita new file mode 100644 index 000000000..e0bae05d4 --- /dev/null +++ b/topics/configuring-the-proxy.dita @@ -0,0 +1,74 @@ + + + + + Configuring the proxy + + Configuring the proxy + + Certain commands, for example, the dita install 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 + ANT_OPTS environment variable. + + + + macOS configure proxy + Linux configure proxy + Windows configure proxy + command line configure proxy + operating system + Linux + macOS + Windows + Java network + ANT_OPTS + Java + ANT_OPTS + metadata + network connection error + metadata + connection timed out + + + + + + + To configure the proxy for a specific session, from the command prompt, issue the + following command: + + + Platform + Command + + + Linux or macOS  + export ANT_OPTS="-Dhttp.proxySet=true \ + -Dhttps.proxyHost=<HTTPS proxy IP address> \ + -Dhttp.proxyHost=<HTTP proxy IP address> \ + -Dhttp.proxyPort=<HTTP proxy port> \ + -Dhttps.proxyPort=<HTTPS proxy port>" + + + Windows + set ANT_OPTS=%ANT_OPTS% -Dhttp.proxySet=true \ + -Dhttps.proxyHost=<HTTPS proxy IP address> \ + -Dhttp.proxyHost=<HTTP proxy IP address> \ + -Dhttp.proxyPort=<HTTP proxy port> \ + -Dhttps.proxyPort=<HTTPS proxy port> + + + + + To persistently change the value, change the value allocated to the + ANT_OPTS environment variable on your system. + + + If a command has previously failed due to a connection timeout, issue the command + again. For + example:dita install <plug-in> + + + diff --git a/topics/troubleshooting.ditamap b/topics/troubleshooting.ditamap index 842b2e8dc..face9e70a 100644 --- a/topics/troubleshooting.ditamap +++ b/topics/troubleshooting.ditamap @@ -11,5 +11,6 @@ +