Skip to content

Commit

Permalink
Merge pull request #153 from AxisCommunications/sync-20241205-1
Browse files Browse the repository at this point in the history
sync 20241205 1
  • Loading branch information
pataxis authored Dec 5, 2024
2 parents ee52ac6 + 36c4363 commit 2589bc1
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,10 @@ An ACAP application can acquire VAPIX service account credentials through a D-Bu

After obtaining the credentials, it's ready to make the actual VAPIX call. The ACAP application communicates with a local server, which then checks the given credentials (using basic access authentication) and forwards the VAPIX request.
> - **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).
1. Define a VAPIX endpoint:
VAPIX calls are essentially HTTP requests and require a URL.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/native-sdk-api.md
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/).
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).

### Compatibility

Expand Down
4 changes: 4 additions & 0 deletions docs/develop/VAPIX-access-for-ACAP-applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,10 @@ An ACAP application can acquire VAPIX service account credentials through a D-Bu

After obtaining the credentials, it's ready to make the actual VAPIX call. The ACAP application communicates with a local server, which then checks the given credentials (using basic access authentication) and forwards the VAPIX request.
> - **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).
1. Define a VAPIX endpoint:
VAPIX calls are essentially HTTP requests and require a URL.
Expand Down
25 changes: 25 additions & 0 deletions docs/develop/global-device-proxy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
layout: page
parent: Develop ACAP applications
title: Global device proxy
nav_order: 10
---

# Global device proxy

Global device proxy settings act as global environment variables on the Axis device. 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.
12 changes: 10 additions & 2 deletions docs/develop/manifest-schemas/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,16 @@ a sub-section means it's only required if the section above is chosen.

Mapping table for manifest schema, AXIS OS and ACAP Native SDK version.

> It's recommended to use the latest manifest version available for the minimum
> AXIS OS version targeted.
> It's recommended to use the latest manifest schema version available in the
> SDK. When [signing an ACAP
> application](../../service/acap-application-signing), the ACAP Portal will
> validate the manifest against the latest released manifest schema version
> within the same major version, which may contain bug fixes to the version
> included in the SDK.
> Note: To sign an ACAP application the minimum manifest schema version
> possible to use is 1.3 that introduced the for signing mandatory field
> `architecture`.
| Schema | AXIS OS | SDK | Description |
| :----- | :------ | :-- | :---------- |
Expand Down

0 comments on commit 2589bc1

Please sign in to comment.