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

Update proxy page (#359) #155

Merged
pataxis merged 2 commits into from
Dec 10, 2024
Merged

Update proxy page (#359) #155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ead2ece
Update proxy page (#359)
isak-jakobsson Dec 10, 2024
9abd54b
Merge remote branch 'upstreamrepo/main'
pataxis Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/acap-sdk-version-3/develop-applications/vapix-access-for-acap-applications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ After obtaining the credentials, it's ready to make the actual VAPIX call. The A

> - **NOTE** If the device has set global device proxy, reaching the local virtual host (127.0.0.12)
> is only possible if 127.0.0.12 is added to the `No proxy` list, as described in
> [Configure-global-device-proxy](./global-device-proxy#configure-global-device-proxy).
> [Configure global device proxy](../../develop/proxy#configure-global-device-proxy).

1. Define a VAPIX endpoint:

Expand Down
2 changes: 1 addition & 1 deletion docs/api/native-sdk-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -541,7 +541,7 @@ The Jansson API was introduced in Native SDK 1.14.

## Curl

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).
Open-source library for transferring data with URLs. See [curl documentation](https://curl.se/docs/). For proxy configuration see [Global device proxy](../develop/proxy).

### Compatibility

Expand Down
2 changes: 1 addition & 1 deletion docs/develop/VAPIX-access-for-ACAP-applications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ After obtaining the credentials, it's ready to make the actual VAPIX call. The A

> - **NOTE** If the device has set global device proxy, reaching the local virtual host (127.0.0.12)
> is only possible if 127.0.0.12 is added to the `No proxy` list, as described in
> [Configure-global-device-proxy](./global-device-proxy#configure-global-device-proxy).
> [Configure global device proxy](./proxy#configure-global-device-proxy).

1. Define a VAPIX endpoint:

Expand Down
25 changes: 0 additions & 25 deletions docs/develop/global-device-proxy.md
View file
Open in desktop

This file was deleted.

49 changes: 49 additions & 0 deletions docs/develop/proxy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
layout: page
parent: Develop ACAP applications
title: Proxy
nav_order: 11
---

# Proxy

## Proxy in build time

The ACAP Native SDK build environment use Docker and if the build machine
is positioned inside a network with proxy, the Docker toolchain needs to be
configured.

### Docker daemon proxy

To enable pull of ACAP Native SDK images from Docker Hub in a network with
proxy, the Docker daemon needs to be configured. For instructions see
<https://docs.docker.com/engine/daemon/proxy>.

### Docker build environment

The build instruction of ACAP applications is defined in the `Dockerfile` and if
the application build tries to connect to external resources such as installing
Ubuntu packages via `apt` or downloading files via `curl` in a network with
proxy, the Docker CLI needs to be configured. For instructions see
<https://docs.docker.com/engine/cli/proxy>.

## Proxy in runtime

To make an ACAP application use a proxy during runtime, it's possible to
configure a global device proxy. Global device proxy settings act as global
environment variables in AXIS OS. There are three types of global device
proxies that can be configured; `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY`.

### Configure global device proxy

Global device proxy can be set via either:

- The VAPIX
[Network Settings API](https://developer.axis.com/vapix/network-video/network-settings-api#setglobalproxyconfiguration-1).
- The network page at `http://<AXIS_DEVICE_IP>/index.html#system/network` and
section `Global proxies`.

### How are ACAP applications affected?

ACAP applications can be affected by global device proxy if they use the curl
API or in any other way are able to pick up proxy from environment variables.
Loading