Skip to content

Commit 4c93d55

Browse files
authored
[DL Streamer Pipeline Server] Updated build documentation (#377)
1 parent 19284d3 commit 4c93d55

2 files changed

Lines changed: 27 additions & 15 deletions

File tree

microservices/dlstreamer-pipeline-server/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Now you have successfully run the Deep Learning Streamer Pipeline Server contain
120120
---
121121
## Build from source
122122

123-
You can build either an optimized or an extended DL Streamer Pipeline Server image (for both Ubuntu22 and Ubuntu24) based on your use case. The extended image contains the Geti SDK and the OpenVINO Model API on top of the optimised image.
123+
You can build either an optimized or an extended DL Streamer Pipeline Server image (for both Ubuntu22 and Ubuntu24) based on your use case. The extended image contains the Geti SDK and the OpenVINO Model API on top of the optimized image.
124124

125125
### Prerequisites
126126
Add the following lines in [.env file](./docker/.env) if you are behind a proxy.

microservices/dlstreamer-pipeline-server/docs/user-guide/how-to-build-from-source.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
# How to build from source
22

3+
You can build either an optimized or an extended DL Streamer Pipeline Server image (for both Ubuntu22 and Ubuntu24) based on your use case. The extended image contains the Geti SDK and the OpenVINO Model API on top of the optimized image.
4+
35
## Steps
46

57
### Prerequisites
8+
9+
Clone the Edge-AI-Libraries repository from open edge platform and change to the docker directory inside DL Streamer Pipeline Server project.
10+
11+
```sh
12+
git clone https://github.com/open-edge-platform/edge-ai-libraries.git
13+
cd edge-ai-libraries/microservices/dlstreamer-pipeline-server/
14+
```
15+
616
Add the following lines in `[WORKDIR]/edge-ai-libraries/microservices/dlstreamer-pipeline-server/docker/.env` if you are behind a proxy.
717

818
``` sh
@@ -18,22 +28,20 @@ Update the following lines for choosing the right base image and also for naming
1828
# For Ubuntu 24.04: intel/dlstreamer:2025.0.1.3-ubuntu24
1929
BASE_IMAGE=
2030

21-
# For Ubuntu 22.04: intel/dlstreamer-pipeline-server:3.1.0-ubuntu22
22-
# For Ubuntu 24.04: intel/dlstreamer-pipeline-server:3.1.0-ubuntu24
31+
# For Ubuntu 22.04 and optimized image: intel/dlstreamer-pipeline-server:3.1.0-ubuntu22
32+
# For Ubuntu 24.04 and optimized image: intel/dlstreamer-pipeline-server:3.1.0-ubuntu24
33+
# For Ubuntu 22.04 and extended image: intel/dlstreamer-pipeline-server:3.1.0-extended-ubuntu22
34+
# For Ubuntu 24.04 and extended image: intel/dlstreamer-pipeline-server:3.1.0-extended-ubuntu24
2335
DLSTREAMER_PIPELINE_SERVER_IMAGE=
36+
37+
# For optimized image: dlstreamer-pipeline-server
38+
# For extended image: dlstreamer-pipeline-server-extended
39+
BUILD_TARGET=
2440
```
2541

2642
### Build DL Streamer Pipeline Server image and start container
2743

28-
1. Clone the Edge-AI-Libraries repository from open edge platform and change to the docker directory inside DL Streamer Pipeline Server project.
29-
30-
```sh
31-
git clone https://github.com/open-edge-platform/edge-ai-libraries.git
32-
cd edge-ai-libraries/microservices/dlstreamer-pipeline-server/
33-
```
34-
---
35-
36-
2. Run the following commands in the project directory
44+
1. Run the following commands in the project directory
3745

3846
```sh
3947
cd docker
@@ -42,15 +50,19 @@ docker compose build
4250
```
4351
---
4452

45-
3. Once the build is complete, list the docker images
53+
2. Once the build is complete, list the docker images
4654
```sh
4755
docker image ls
4856
```
49-
Verify the following image `intel/dlstreamer-pipeline-server:<latest-version-number>-ubuntu22` or `intel/dlstreamer-pipeline-server:<latest-version-number>-ubuntu24` is present in the system after the build is successful
57+
Based on the `.env` file changes done above, verify that the appropriate image from the following is present in the system after the build is successful
58+
- `intel/dlstreamer-pipeline-server:<latest-version-number>-ubuntu22`
59+
- `intel/dlstreamer-pipeline-server:<latest-version-number>-ubuntu24`
60+
- `intel/dlstreamer-pipeline-server:<latest-version-number>-extended-ubuntu22`
61+
- `intel/dlstreamer-pipeline-server:<latest-version-number>-extended-ubuntu24`
5062

5163
---
5264

53-
4. Run the below command to start the container
65+
3. Run the below command to start the container
5466
```sh
5567
docker compose up
5668
```

0 commit comments

Comments
 (0)