Skip to content

Commit 8305041

Browse files
Update build instructions (#463) (#433)
Co-authored-by: Fernando Esquirio Torres <[email protected]>
1 parent 6b29639 commit 8305041

File tree

34 files changed

+237
-85
lines changed

34 files changed

+237
-85
lines changed

audio-capture/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Standing in your working directory run the following commands:
4747
> [Proxy in build time](https://developer.axis.com/acap/develop/proxy/#proxy-in-build-time).
4848
4949
```sh
50-
docker build --tag <APP_IMAGE> .
50+
docker build --platform=linux/amd64 --tag <APP_IMAGE> .
5151
```
5252

5353
<APP_IMAGE> is the name to tag the image with, e.g., audiocapture:1.0
@@ -63,7 +63,7 @@ docker build --build-arg ARCH=aarch64 --tag <APP_IMAGE> .
6363
Copy the result from the container image to a local directory build:
6464

6565
```sh
66-
docker cp $(docker create <APP_IMAGE>):/opt/app ./build
66+
docker cp $(docker create --platform=linux/amd64 <APP_IMAGE>):/opt/app ./build
6767
```
6868

6969
The working dir now contains a build folder with the following files:
@@ -98,6 +98,10 @@ audio-capture
9898
- **build/Audio_capture_1_0_0_armv7hf.eap** - Application package .eap file.
9999
- **build/Audio_capture_1_0_0_LICENSE.txt** - Copy of LICENSE file.
100100

101+
> [!NOTE]
102+
>
103+
> For detailed information on how to build, install, and run ACAP applications, refer to the official ACAP documentation: [Build, install, and run](https://developer.axis.com/acap/develop/build-install-run/).
104+
101105
#### Install and start the application
102106

103107
Browse to the application page of the Axis device:

audio-playback/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Standing in your working directory run the following commands:
4747
> [Proxy in build time](https://developer.axis.com/acap/develop/proxy/#proxy-in-build-time).
4848
4949
```sh
50-
docker build --tag <APP_IMAGE> .
50+
docker build --platform=linux/amd64 --tag <APP_IMAGE> .
5151
```
5252

5353
<APP_IMAGE> is the name to tag the image with, e.g., audioplayback:1.0
@@ -63,7 +63,7 @@ docker build --build-arg ARCH=aarch64 --tag <APP_IMAGE> .
6363
Copy the result from the container image to a local directory build:
6464

6565
```sh
66-
docker cp $(docker create <APP_IMAGE>):/opt/app ./build
66+
docker cp $(docker create --platform=linux/amd64 <APP_IMAGE>):/opt/app ./build
6767
```
6868

6969
The working dir now contains a build folder with the following files:
@@ -98,6 +98,10 @@ audio-playback
9898
- **build/Audio_playback_1_0_0_armv7hf.eap** - Application package .eap file.
9999
- **build/Audio_playback_1_0_0_LICENSE.txt** - Copy of LICENSE file.
100100

101+
> [!NOTE]
102+
>
103+
> For detailed information on how to build, install, and run ACAP applications, refer to the official ACAP documentation: [Build, install, and run](https://developer.axis.com/acap/develop/build-install-run/).
104+
101105
#### Install and start the application
102106

103107
Browse to the application page of the Axis device:

axevent/send_event/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Standing in your working directory run the following commands:
5656
> [Proxy in build time](https://developer.axis.com/acap/develop/proxy/#proxy-in-build-time).
5757
5858
```sh
59-
docker build --tag <APP_IMAGE> .
59+
docker build --platform=linux/amd64 --tag <APP_IMAGE> .
6060
```
6161

6262
<APP_IMAGE> is the name to tag the image with, e.g., send-event:1.0
@@ -72,7 +72,7 @@ docker build --build-arg ARCH=aarch64 --tag <APP_IMAGE> .
7272
Copy the result from the container image to a local directory build:
7373

7474
```sh
75-
docker cp $(docker create <APP_IMAGE>):/opt/app ./build
75+
docker cp $(docker create --platform=linux/amd64 <APP_IMAGE>):/opt/app ./build
7676
```
7777

7878
The working dir now contains a build folder with the following files:
@@ -107,6 +107,10 @@ send_event
107107
- **build/send_event_1_0_0_armv7hf.eap** - Application package .eap file for "send_event".
108108
- **build/send_event_1_0_0_LICENSE.txt** - Copy of LICENSE file.
109109

110+
> [!NOTE]
111+
>
112+
> For detailed information on how to build, install, and run ACAP applications, refer to the official ACAP documentation: [Build, install, and run](https://developer.axis.com/acap/develop/build-install-run/).
113+
110114
#### Install and start the application
111115

112116
Browse to the application page of the Axis device:

axevent/subscribe_to_event/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Standing in your working directory run the following commands:
4747
> [Proxy in build time](https://developer.axis.com/acap/develop/proxy/#proxy-in-build-time).
4848
4949
```sh
50-
docker build --tag <APP_IMAGE> .
50+
docker build --platform=linux/amd64 --tag <APP_IMAGE> .
5151
```
5252

5353
<APP_IMAGE> is the name to tag the image with, e.g., subscribe-to-event:1.0
@@ -63,7 +63,7 @@ docker build --build-arg ARCH=aarch64 --tag <APP_IMAGE> .
6363
Copy the result from the container image to a local directory build:
6464

6565
```sh
66-
docker cp $(docker create <APP_IMAGE>):/opt/app ./build
66+
docker cp $(docker create --platform=linux/amd64 <APP_IMAGE>):/opt/app ./build
6767
```
6868

6969
The working dir now contains a build folder with the following files:
@@ -97,6 +97,10 @@ subscribe_to_event
9797
- **build/subscribe_to_event_1_0_0_armv7hf.eap** - Application package .eap file for "subscribe_to_event".
9898
- **build/subscribe_to_event_1_0_0_LICENSE.txt** - Copy of LICENSE file.
9999

100+
> [!NOTE]
101+
>
102+
> For detailed information on how to build, install, and run ACAP applications, refer to the official ACAP documentation: [Build, install, and run](https://developer.axis.com/acap/develop/build-install-run/).
103+
100104
#### Install and start the application
101105

102106
Browse to the application page of the Axis device:

axevent/subscribe_to_events/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Standing in your working directory run the following commands:
5353
> [Proxy in build time](https://developer.axis.com/acap/develop/proxy/#proxy-in-build-time).
5454
5555
```sh
56-
docker build --tag <APP_IMAGE> .
56+
docker build --platform=linux/amd64 --tag <APP_IMAGE> .
5757
```
5858

5959
<APP_IMAGE> is the name to tag the image with, e.g., subscribe-to-events:1.0
@@ -69,7 +69,7 @@ docker build --build-arg ARCH=aarch64 --tag <APP_IMAGE> .
6969
Copy the result from the container image to a local directory build:
7070

7171
```sh
72-
docker cp $(docker create <APP_IMAGE>):/opt/app ./build
72+
docker cp $(docker create --platform=linux/amd64 <APP_IMAGE>):/opt/app ./build
7373
```
7474

7575
The working dir now contains a build folder with the following files:
@@ -105,6 +105,10 @@ subscribe_to_events
105105
- **build/subscribe_to_events_1_0_0_armv7hf.eap** - Application package .eap file.
106106
- **build/subscribe_to_events_1_0_0_LICENSE.txt** - Copy of LICENSE file.
107107

108+
> [!NOTE]
109+
>
110+
> For detailed information on how to build, install, and run ACAP applications, refer to the official ACAP documentation: [Build, install, and run](https://developer.axis.com/acap/develop/build-install-run/).
111+
108112
#### Install and start the application
109113

110114
Browse to the application page of the Axis device:

axoverlay/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Standing in your working directory run the following commands:
5555
> [Proxy in build time](https://developer.axis.com/acap/develop/proxy/#proxy-in-build-time).
5656
5757
```sh
58-
docker build --tag <APP_IMAGE> --build-arg ARCH=<ARCH> .
58+
docker build --platform=linux/amd64 --tag <APP_IMAGE> --build-arg ARCH=<ARCH> .
5959
```
6060

6161
- <APP_IMAGE> is the name to tag the image with, e.g., axoverlay:1.0
@@ -64,7 +64,7 @@ docker build --tag <APP_IMAGE> --build-arg ARCH=<ARCH> .
6464
Copy the result from the container image to a local directory build:
6565

6666
```sh
67-
docker cp $(docker create <APP_IMAGE>):/opt/app ./build
67+
docker cp $(docker create --platform=linux/amd64 <APP_IMAGE>):/opt/app ./build
6868
```
6969

7070
The working dir now contains a build folder with the following files:
@@ -99,6 +99,10 @@ axoverlay
9999
- **build/package.conf.orig** - Defines the application and its configuration, original file.
100100
- **build/param.conf** - File containing application parameters.
101101

102+
> [!NOTE]
103+
>
104+
> For detailed information on how to build, install, and run ACAP applications, refer to the official ACAP documentation: [Build, install, and run](https://developer.axis.com/acap/develop/build-install-run/).
105+
102106
#### Install your application
103107

104108
Installing your application on an Axis video device is as simple as:

axparameter/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Standing in your working directory run the following commands:
7979
> [Proxy in build time](https://developer.axis.com/acap/develop/proxy/#proxy-in-build-time).
8080
8181
```sh
82-
docker build --tag <APP_IMAGE> --build-arg ARCH=<ARCH> .
82+
docker build --platform=linux/amd64 --tag <APP_IMAGE> --build-arg ARCH=<ARCH> .
8383
```
8484

8585
- `<APP_IMAGE>` is the name to tag the image with, e.g., `axparameter:1.0`
@@ -88,7 +88,7 @@ docker build --tag <APP_IMAGE> --build-arg ARCH=<ARCH> .
8888
Copy the result from the container image to a local directory `build`:
8989

9090
```sh
91-
docker cp $(docker create <APP_IMAGE>):/opt/app ./build
91+
docker cp $(docker create --platform=linux/amd64 <APP_IMAGE>):/opt/app ./build
9292
```
9393

9494
The `build` directory contains the build artifacts, where the ACAP application
@@ -98,6 +98,10 @@ chosen, one of these files should be found:
9898
- `axparameter_1_0_0_aarch64.eap`
9999
- `axparameter_1_0_0_armv7hf.eap`
100100

101+
> [!NOTE]
102+
>
103+
> For detailed information on how to build, install, and run ACAP applications, refer to the official ACAP documentation: [Build, install, and run](https://developer.axis.com/acap/develop/build-install-run/).
104+
101105
## Install and start the application
102106

103107
Browse to the application page of the Axis device:

axserialport/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Standing in your working directory run the following commands:
4242
> [Proxy in build time](https://developer.axis.com/acap/develop/proxy/#proxy-in-build-time).
4343
4444
```sh
45-
docker build --tag <APP_IMAGE> .
45+
docker build --platform=linux/amd64 --tag <APP_IMAGE> .
4646
```
4747

4848
`<APP_IMAGE>` is the name to tag the image with, e.g., `axserialport:1.0`
@@ -58,7 +58,7 @@ docker build --build-arg ARCH=aarch64 --tag <APP_IMAGE> .
5858
Copy the result from the container image to a local directory called `build`:
5959

6060
```sh
61-
docker cp $(docker create <APP_IMAGE>):/opt/app ./build
61+
docker cp $(docker create --platform=linux/amd64 <APP_IMAGE>):/opt/app ./build
6262
```
6363

6464
The working directory now contains a build folder with the following files:
@@ -86,6 +86,10 @@ build
8686
- **axserialport_1_0_0_armv7hf.eap** - Application package .eap file.
8787
- **axserialport_1_0_0_LICENSE.txt** - Copy of LICENSE file.
8888

89+
> [!NOTE]
90+
>
91+
> For detailed information on how to build, install, and run ACAP applications, refer to the official ACAP documentation: [Build, install, and run](https://developer.axis.com/acap/develop/build-install-run/).
92+
8993
#### Install and start the application
9094

9195
Browse to the application page of the Axis device:

axstorage/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Standing in your working directory run the following commands:
3939
> [Proxy in build time](https://developer.axis.com/acap/develop/proxy/#proxy-in-build-time).
4040
4141
```sh
42-
docker build --tag <APP_IMAGE> .
42+
docker build --platform=linux/amd64 --tag <APP_IMAGE> .
4343
```
4444

4545
`<APP_IMAGE>` is the name to tag the image with, e.g., `axstorage:1.0`
@@ -55,7 +55,7 @@ docker build --build-arg ARCH=aarch64 --tag <APP_IMAGE> .
5555
Copy the result from the container image to a local directory called `build`:
5656

5757
```sh
58-
docker cp $(docker create <APP_IMAGE>):/opt/app ./build
58+
docker cp $(docker create --platform=linux/amd64 <APP_IMAGE>):/opt/app ./build
5959
```
6060

6161
The working directory now contains a build folder with the following files:
@@ -83,6 +83,10 @@ build
8383
- **axstorage_1_0_0_armv7hf.eap** - Application package .eap file.
8484
- **axstorage_1_0_0_LICENSE.txt** - Copy of LICENSE file.
8585

86+
> [!NOTE]
87+
>
88+
> For detailed information on how to build, install, and run ACAP applications, refer to the official ACAP documentation: [Build, install, and run](https://developer.axis.com/acap/develop/build-install-run/).
89+
8690
#### Install and start the application
8791

8892
Browse to the application page of the Axis device:

bounding-box/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Standing in your working directory run the following commands:
5555
> [Proxy in build time](https://developer.axis.com/acap/develop/proxy/#proxy-in-build-time).
5656
5757
```sh
58-
docker build --tag <APP_IMAGE> --build-arg ARCH=<ARCH> .
58+
docker build --platform=linux/amd64 --tag <APP_IMAGE> --build-arg ARCH=<ARCH> .
5959
```
6060

6161
- `<APP_IMAGE>` is the name to tag the image with, e.g., `bbox:1.0`
@@ -64,7 +64,7 @@ docker build --tag <APP_IMAGE> --build-arg ARCH=<ARCH> .
6464
Copy the result from the container image to a local directory `build`:
6565

6666
```sh
67-
docker cp $(docker create <APP_IMAGE>):/opt/app ./build
67+
docker cp $(docker create --platform=linux/amd64 <APP_IMAGE>):/opt/app ./build
6868
```
6969

7070
The `build` directory contains the build artifacts, where the ACAP application
@@ -74,6 +74,10 @@ chosen, one of these files should be found:
7474
- `AXIS_Bounding_Box_Example_1_0_0_aarch64.eap`
7575
- `AXIS_Bounding_Box_Example_1_0_0_armv7hf.eap`
7676

77+
> [!NOTE]
78+
>
79+
> For detailed information on how to build, install, and run ACAP applications, refer to the official ACAP documentation: [Build, install, and run](https://developer.axis.com/acap/develop/build-install-run/).
80+
7781
## Install and start the application
7882

7983
Browse to the application page of the Axis device:

0 commit comments

Comments
 (0)