Skip to content

Commit e87cc88

Browse files
github-actions[bot]Stiv-workmadelen-at-work
authored
Add documentation for setting proxy (#167)
* Add documentation for setting proxy * Add dockumentation for setting proxy Change-Id: I0ad7263cfc4921059dda637014308a3ba6630360 * Update for received comments Change-Id: I309da850391a4a20e6170f2515f2f4ba6a97ce37 * wip Change-Id: I70d9c7643f9cd042ca4579a16328abf3badbe24f * Resolving comments Change-Id: I61abdb32e48586dd5a4007989e4d4c85f3100443 * lint Change-Id: I17cf6325fbfda3f9ebaf71f6b259f37535186d75 * fixed some formatting issues * update to comments Change-Id: I537672ab8be0eeec902a7c9a3c8212a67e370998 * Update Developer Mode doc link Change-Id: I4d8e3939dca7a65285aca26227a25120770fc43e --------- Co-authored-by: madelen-at-work <madelen-at-work@users.noreply.github.com> * Update README.md * Update README.md --------- Co-authored-by: Stiv Abdullwahed <stiva@axis.com> Co-authored-by: madelen-at-work <madelen-at-work@users.noreply.github.com> Co-authored-by: Madelen Andersson <madelen.andersson@axis.com>
1 parent cf75a0d commit e87cc88

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

+30-2
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@ Make sure the application, using TLS, is running, then pull and run the
374374
$ docker --tlsverify --host tcp://<device-ip>:2376 pull hello-world
375375
Using default tag: latest
376376
latest: Pulling from library/hello-world
377-
70f5ac315c5a: Pull complete
377+
70f5ac315c5a: Pull complete
378378
Digest: sha256:88ec0acaa3ec199d3b7eaf73588f4518c25f9d34f58ce9a0df68429c5af48e8d
379379
Status: Downloaded newer image for hello-world:latest
380380
docker.io/library/hello-world:latest
@@ -403,6 +403,32 @@ For more examples and ideas, visit:
403403

404404
```
405405

406+
#### Proxy Setup
407+
408+
If the device is located behind a proxy the Docker daemon needs to be configured.
409+
This is done by configuring proxy behavior for dockerd in the daemon.json file as described in
410+
['Configure the Docker daemon to use a proxy server'][docker-proxy].
411+
412+
The daemon.json file should be located at `/usr/local/packages/dockerdwrapperwithcompose/localdata/daemon.json`
413+
on the device and should include the following properties:
414+
415+
```json
416+
{
417+
"proxies": {
418+
"http-proxy": "http://proxy.example.com:3128",
419+
"https-proxy": "https://proxy.example.com:3129",
420+
"no-proxy": "*.test.example.com,.example.org,127.0.0.0/8"
421+
}
422+
}
423+
```
424+
425+
Setting the contents of the daemon.json file can be done either by adding it to the source code and
426+
rebuilding the application or by logging into the device over SSH with an already installed application and updating
427+
the file.
428+
In the latter case [Developer Mode][developermode] is needed, see that documentation for further details.
429+
Also note that, if the application is running when the file is updated, it needs to be restarted for
430+
the change to take effect.
431+
406432
#### Loading images onto a device
407433

408434
If you have images in a local repository that you want to transfer to a device, or
@@ -473,12 +499,14 @@ Take a look at the [CONTRIBUTING.md](CONTRIBUTING.md) file.
473499
[acap-native-container-example]: https://github.com/AxisCommunications/acap-native-sdk-examples/tree/main/container-example
474500
[buildx]: https://docs.docker.com/build/install-buildx/
475501
[devices]: https://axiscommunications.github.io/acap-documentation/docs/axis-devices-and-compatibility#sdk-and-device-compatibility
502+
[developermode]: http://axiscommunications.github.io/acap-documentation/docs/get-started/set-up-developer-environment/set-up-device-advanced.html#developer-mode
476503
[dockerDesktop]: https://docs.docker.com/desktop/
477504
[docker_protect-access]: https://docs.docker.com/engine/security/protect-access/
478505
[dockerEngine]: https://docs.docker.com/engine/
479506
[docker-hello-world]: https://hub.docker.com/_/hello-world
480507
[docker-rootless-mode]: https://docs.docker.com/engine/security/rootless/
481-
[latest-release]: https://github.com/AxisCommunications/docker-compose-acap/releases/latest
508+
[docker-proxy]: https://docs.docker.com/config/daemon/systemd/#httphttps-proxy
509+
[latest-release]: https://github.com/AxisCommunications/docker-acap/releases/latest
482510
[object-detector-python]: https://github.com/AxisCommunications/acap-computer-vision-sdk-examples/tree/main/object-detector-python
483511
[product-selector]: https://www.axis.com/support/tools/product-selector
484512
[product-selector-container]: https://www.axis.com/support/tools/product-selector/shared/%5B%7B%22index%22%3A%5B4%2C2%5D%2C%22value%22%3A%22Yes%22%7D%5D

0 commit comments

Comments
 (0)