Skip to content
This repository was archived by the owner on Feb 6, 2025. It is now read-only.

Commit e935b2b

Browse files
authored
Merge pull request #155 from AxisCommunications/sync-20241210-1
Update proxy page (#359)
2 parents dbcf541 + 9abd54b commit e935b2b

File tree

5 files changed

+52
-28
lines changed

5 files changed

+52
-28
lines changed

docs/acap-sdk-version-3/develop-applications/vapix-access-for-acap-applications.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ After obtaining the credentials, it's ready to make the actual VAPIX call. The A
108108
109109
> - **NOTE** If the device has set global device proxy, reaching the local virtual host (127.0.0.12)
110110
> is only possible if 127.0.0.12 is added to the `No proxy` list, as described in
111-
> [Configure-global-device-proxy](./global-device-proxy#configure-global-device-proxy).
111+
> [Configure global device proxy](../../develop/proxy#configure-global-device-proxy).
112112
113113
1. Define a VAPIX endpoint:
114114

docs/api/native-sdk-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -541,7 +541,7 @@ The Jansson API was introduced in Native SDK 1.14.
541541

542542
## Curl
543543

544-
Open-source library for transferring data with URLs. See [curl documentation](https://curl.se/docs/). For proxy configuration see [Global device proxy](../develop/global-device-proxy).
544+
Open-source library for transferring data with URLs. See [curl documentation](https://curl.se/docs/). For proxy configuration see [Global device proxy](../develop/proxy).
545545

546546
### Compatibility
547547

docs/develop/VAPIX-access-for-ACAP-applications.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ After obtaining the credentials, it's ready to make the actual VAPIX call. The A
101101
102102
> - **NOTE** If the device has set global device proxy, reaching the local virtual host (127.0.0.12)
103103
> is only possible if 127.0.0.12 is added to the `No proxy` list, as described in
104-
> [Configure-global-device-proxy](./global-device-proxy#configure-global-device-proxy).
104+
> [Configure global device proxy](./proxy#configure-global-device-proxy).
105105
106106
1. Define a VAPIX endpoint:
107107

docs/develop/global-device-proxy.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

docs/develop/proxy.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
layout: page
3+
parent: Develop ACAP applications
4+
title: Proxy
5+
nav_order: 11
6+
---
7+
8+
# Proxy
9+
10+
## Proxy in build time
11+
12+
The ACAP Native SDK build environment use Docker and if the build machine
13+
is positioned inside a network with proxy, the Docker toolchain needs to be
14+
configured.
15+
16+
### Docker daemon proxy
17+
18+
To enable pull of ACAP Native SDK images from Docker Hub in a network with
19+
proxy, the Docker daemon needs to be configured. For instructions see
20+
<https://docs.docker.com/engine/daemon/proxy>.
21+
22+
### Docker build environment
23+
24+
The build instruction of ACAP applications is defined in the `Dockerfile` and if
25+
the application build tries to connect to external resources such as installing
26+
Ubuntu packages via `apt` or downloading files via `curl` in a network with
27+
proxy, the Docker CLI needs to be configured. For instructions see
28+
<https://docs.docker.com/engine/cli/proxy>.
29+
30+
## Proxy in runtime
31+
32+
To make an ACAP application use a proxy during runtime, it's possible to
33+
configure a global device proxy. Global device proxy settings act as global
34+
environment variables in AXIS OS. There are three types of global device
35+
proxies that can be configured; `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY`.
36+
37+
### Configure global device proxy
38+
39+
Global device proxy can be set via either:
40+
41+
- The VAPIX
42+
[Network Settings API](https://developer.axis.com/vapix/network-video/network-settings-api#setglobalproxyconfiguration-1).
43+
- The network page at `http://<AXIS_DEVICE_IP>/index.html#system/network` and
44+
section `Global proxies`.
45+
46+
### How are ACAP applications affected?
47+
48+
ACAP applications can be affected by global device proxy if they use the curl
49+
API or in any other way are able to pick up proxy from environment variables.

0 commit comments

Comments
 (0)