DEV: Add proxy section

Co-authored-by: Patrik Åkesson <[email protected]>

DEV.md

@@ -1,8 +1,20 @@
+<!-- omit from toc -->
 # ACAP application developer topics
 
 This page is a collection of common topics related to ACAP application
 development.
 
+<!-- omit from toc -->
+## Table of contents
+
+- [Access the device](#access-the-device)
+- [Developer Mode](#developer-mode)
+- [Logs and reports](#logs-and-reports)
+  - [Access the system log](#access-the-system-log)
+  - [Access the application log](#access-the-application-log)
+  - [Access the server report](#access-the-server-report)
+- [Proxy](#proxy)
+
 ## Access the device
 
 To log in to an Axis device shell to perform command-line options, **SSH** is
@@ -66,10 +78,21 @@ The system report can be accessed,
    curl --anyauth -u <username>:<password> http://<AXIS_DEVICE_IP>/axis-cgi/serverreport.cgi
    ```
 
+## Proxy
+
+To develop or run ACAP applications from inside a network with proxy, additional
+configuration is needed. More information about proxy and instructions on
+how to configure are available in the ACAP documentation [Proxy][proxy] page, or
+specifically in the [Proxy in build time][proxy-in-build-time] and
+[Proxy in runtime][proxy-in-runtime] sections.
+
 <!-- Links to external references -->
 <!-- markdownlint-disable MD034 -->
 [access-device-through-ssh]: https://axiscommunications.github.io/acap-documentation/docs/get-started/set-up-developer-environment/set-up-device-advanced.html#access-the-device-through-ssh
 [developer-mode]: https://axiscommunications.github.io/acap-documentation/docs/get-started/set-up-developer-environment/set-up-device-advanced.html#developer-mode
 [server-report-cgi]: https://www.axis.com/vapix-library/subjects/t10175981/section/t10036044/display?section=t10036044-t10003915
 [system-log-cgi]: https://www.axis.com/vapix-library/subjects/t10175981/section/t10036044/display?section=t10036044-t10003913
-<!-- markdownlint-enable MD034 -->
+[proxy]: https://axiscommunications.github.io/acap-documentation/docs/develop/proxy
+[proxy-in-build-time]: https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time
+[proxy-in-runtime]: https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-runtim
+<!-- markdownlint-enable MD034 -->

axevent/send_event/README.md

@@ -49,12 +49,11 @@ Below is the step by step instructions on how to execute the program. So basical
 
 Standing in your working directory run the following commands:
 
-> **Note**
+> [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings) in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for Docker. See
+> [Proxy in build time](https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time).
 
 ```sh
 docker build --tag <APP_IMAGE> .

axevent/subscribe_to_event/README.md

@@ -40,12 +40,11 @@ Below is the step by step instructions on how to execute the program. So basical
 
 Standing in your working directory run the following commands:
 
-> **Note**
+> [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings) in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for Docker. See
+> [Proxy in build time](https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time).
 
 ```sh
 docker build --tag <APP_IMAGE> .

axevent/subscribe_to_events/README.md

@@ -46,12 +46,11 @@ Below is the step by step instructions on how to execute the program. So basical
 
 Standing in your working directory run the following commands:
 
-> **Note**
+> [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings) in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for Docker. See
+> [Proxy in build time](https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time).
 
 ```sh
 docker build --tag <APP_IMAGE> .

axoverlay/README.md

@@ -48,12 +48,11 @@ Below is the step by step instructions on how to execute the program. So basical
 
 Standing in your working directory run the following commands:
 
-> **Note**
+> [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings) in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for Docker. See
+> [Proxy in build time](https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time).
 
 ```sh
 docker build --tag <APP_IMAGE> --build-arg ARCH=<ARCH> .

axparameter/README.md

@@ -74,11 +74,9 @@ Standing in your working directory run the following commands:
 
 > [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings)
-> in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for Docker. See
+> [Proxy in build time](https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time).
 
 ```sh
 docker build --tag <APP_IMAGE> --build-arg ARCH=<ARCH> .

axserialport/README.md

@@ -37,10 +37,9 @@ Standing in your working directory run the following commands:
 
 > [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings) in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for Docker. See
+> [Proxy in build time](https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time).
 
 ```sh
 docker build --tag <APP_IMAGE> .

axstorage/README.md

@@ -34,10 +34,9 @@ Standing in your working directory run the following commands:
 
 > [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings) in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for Docker. See
+> [Proxy in build time](https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time).
 
 ```sh
 docker build --tag <APP_IMAGE> .

bounding-box/README.md

@@ -50,11 +50,9 @@ Standing in your working directory run the following commands:
 
 > [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings)
-> in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for Docker. See
+> [Proxy in build time](https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time).
 
 ```sh
 docker build --tag <APP_IMAGE> --build-arg ARCH=<ARCH> .

container-example/README.md

@@ -100,10 +100,9 @@ Standing in your working directory run the following commands:
 
 > [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings) in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for Docker. See
+> [Proxy in build time](https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time).
 
 Pull the [Alpine linux container image][alpine] and save it to a .tar file.
 

curl-openssl/README.md

@@ -46,10 +46,9 @@ Standing in your working directory run the following commands:
 
 > [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings) in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for Docker. See
+> [Proxy in build time](https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time).
 
 ```sh
 docker build --tag <APP_IMAGE> --build-arg ARCH=<ARCH> .
@@ -74,6 +73,10 @@ To get more verbose logging from curl, pass the build argument `APP_DEBUG=yes`:
 docker build --build-arg APP_DEBUG=yes --tag <APP_IMAGE> --build-arg ARCH=<ARCH> .
 ```
 
+If the device is inside a network with a proxy, the global device proxy must be
+set to allow curl to pick it up at runtime. For reference see
+[Configure global device proxy](https://axiscommunications.github.io/acap-documentation/docs/develop/global-device-proxy.md#configure-global-device-proxy).
+
 Copy the result from the container image to a local directory `build`:
 
 ```sh

hello-world/README.md

@@ -36,12 +36,11 @@ Below is the step by step instructions on how to execute the program. So basical
 
 Standing in your working directory run the following commands:
 
-> **Note**
+> [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings) in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for Docker. See
+> [Proxy in build time](https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time).
 
 ```sh
 docker build --tag <APP_IMAGE> .

licensekey/README.md

@@ -40,12 +40,11 @@ Below is the step by step instructions on how to execute the program. So basical
 
 Standing in your working directory run the following commands:
 
-> **Note**
+> [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings) in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for Docker. See
+> [Proxy in build time](https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time).
 
 ```sh
 docker build --tag <APP_IMAGE> .

message-broker/consume-scene-metadata/README.md

@@ -145,10 +145,8 @@ Standing in your working directory run the following commands:
 
 > [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings) in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for docker. See [Proxy in build time](../DEV.md#proxy-in-build-time).
 
 ```sh
 docker build --tag <APP_IMAGE> --build-arg ARCH=<ARCH> .

object-detection-cv25/README.md

@@ -223,6 +223,12 @@ and added to the ACAP application via the -a flag in the
 The application is built to specification by the `Makefile` and `manifest.json`
 in the [app](app) directory. Standing in the application directory, run:
 
+> [!NOTE]
+>
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for Docker. See
+> [Proxy in build time](https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time).
+
 ```sh
 docker build --tag obj_detect:1.0 .
 docker cp $(docker create obj_detect:1.0):/opt/app ./build

object-detection/README.md

@@ -212,6 +212,12 @@ downloaded and added to the ACAP application via the -a flag in the
 The application is built to specification by the `Makefile` and `manifest.json`
 in the [app](app) directory. Standing in the application directory, run:
 
+> [!NOTE]
+>
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for Docker. See
+> [Proxy in build time](https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time).
+
 ```sh
 docker build --build-arg ARCH=<ARCH> --build-arg CHIP=<CHIP> --tag obj_detect:1.0 .
 docker cp $(docker create obj_detect:1.0):/opt/app ./build

reproducible-package/README.md

@@ -53,12 +53,11 @@ and not how a real application would be built.
 
 Standing in your working directory follow the commands below:
 
-> **Note**
+> [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings) in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for Docker. See
+> [Proxy in build time](https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time).
 
 In all examples the option `--no-cache` is used to ensure that image is rebuilt.
 

shell-script-example/README.md

@@ -36,12 +36,11 @@ Below is the step by step instructions on how to execute the program. So basical
 
 Standing in your working directory run the following commands:
 
-> **Note**
+> [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings) in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for Docker. See
+> [Proxy in build time](https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time).
 
 ```sh
 docker build --tag <APP_IMAGE> .

using-opencv/README.md

@@ -27,12 +27,11 @@ building-opencv
 
 ### Quick start
 
-> **Note**
+> [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings) in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for Docker. See
+> [Proxy in build time](https://axiscommunications.github.io/acap-documentation/docs/develop/proxy#proxy-in-build-time).
 
 1. Standing in your working directory run the following commands:
 

utility-libraries/custom_lib_example/README.md

@@ -39,12 +39,10 @@ Below is the step by step instructions on how to execute the program. So basical
 
 Standing in your working directory run the following commands:
 
-> **Note**
+> [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings) in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for docker. See [Proxy in build time](../DEV.md#proxy-in-build-time).
 
 ```sh
 docker build --tag <APP_IMAGE> .

utility-libraries/openssl_curl_example/README.md

@@ -112,12 +112,10 @@ the application on a device.
 
 ### Build the application
 
-> **Note**
+> [!NOTE]
 >
-> Depending on the network you are connected to, you may need to add proxy settings.
-> The file that needs these settings is: `~/.docker/config.json`. For reference please see
-> https://docs.docker.com/network/proxy and a
-> [script for Axis devices](https://axiscommunications.github.io/acap-documentation/docs/develop/build-install-run.html#configure-network-proxy-settings) in the ACAP documentation.
+> Depending on the network your local build machine is connected to, you may need to add proxy
+> settings for docker. See [Proxy in build time](../DEV.md#proxy-in-build-time).
 
 Standing in your working directory run: