Installation

Ensure the desired server meets the minimum requirements.

License is Required

Bitstreams Software requires a valid license. Without a valid license the Software will operate in read-only mode.

To apply a new or updated license see the License section in the User Guide.

---

Install Docker

1. Install Docker as per the instructions provided by Docker

   warning

   If docker has not been installed, or installed incorrectly the Bitstreams Edge will not properly install.

2. Add the current user to the docker group

   sudo usermod -aG docker $USER

3. Log out and log back in so that your group membership is re-evaluated.

Download Release

1. Download the Bitstreams Edge Release

   Download: arm64 / aarch64 Download: x86_64 / amd64

2. Extract the software package and enter the directory.

   unzip Bitstreams_Edge_vX.X.X_*.zip
   cd  ~/Bitstreams_Edge_vX.X.X_*

Install Script

1. Use the quick install script as shown below:

   warning

   The quick install script requires Python 3.8+

   # Basic usage
   ./edge_quick_installer.py ipv4Addr {http,https}
   
   # Example installation
   ./edge_quick_installer.py 10.0.100.10 http
   
   # For advanced features and to view all options
   ./edge_quick_installer.py -h

2. Run the installation script using the basic install process ./edge_quick_installer.py 10.0.100.10 http, where you replace 10.0.100.10 with your server's IP address.

3. Follow the instructions in the installation script to complete the process.

4. Once the installation is complete and successful, you should see:

Starting Bitstreams services...
[+] Running 11/11
✔ Container configs-netint-bitstream-mysql-1                Healthy                 0.4s
✔ Container configs-netint-bitstream-etcdkeeper-1           Started                 0.4s
✔ Container configs-netint-bitstream-etcd-1                 Healthy                 0.4s
✔ Container configs-netint-bitstream-redis-1                Healthy                 0.4s
✔ Container configs-netint-bitstream-nginx-1                Started                 0.4s
✔ Container configs-netint-bitstream-minio-1                Started                 0.4s
✔ Container configs-netint-bitstream-stream-live-1          Started                 0.4s
✔ Container configs-netint-bitstream-gateway-1              Started                 0.4s
✔ Container configs-netint-bitstream-lms-1                  Healthy                 0.0s
✔ Container configs-netint-bitstream-nvs-1                  Healthy                 0.0s
✔ Container configs-netint-bitstream-stream-trans-1         Started                 0.0s

Completed.

11. Check the status using docker ps, the output should look similar to the one below.

 CONTAINER ID   IMAGE                                                                                 COMMAND                  CREATED       STATUS                PORTS     NAMES
 fe43cc7b3522   yyz1harbor01.netint.ca/bitstreams/notification:release_v2.1.1_RC1                     "./notification --co…"   3 weeks ago   Up 9 days (healthy)             configs-notification-1
 b8dfd2c06086   yyz1harbor01.netint.ca/bitstreams/nvs:release_v2.1.1_RC6                              "./nvs --config conf…"   3 weeks ago   Up 9 days (healthy)             configs-nvs-1
 97f1958d60af   yyz1harbor01.netint.ca/bitstreams/stream-trans:9b540829-280b5f4d-arm64                "./stream-trans --co…"   3 weeks ago   Up 9 days (healthy)             configs-stream-trans-1
 f356f9d11887   yyz1harbor01.netint.ca/bitstreams/lms:release_v2.1.1_RC2-bqe                          "./lms --config conf…"   3 weeks ago   Up 9 days (healthy)             configs-lms-1
 6921b7e9b43a   yyz1harbor01.netint.ca/bitstreams/gateway:release_v2.1.1_RC2-release_v2.1.1_RC2-bqe   "/bin/sh -c 'crond &…"   3 weeks ago   Up 9 days (healthy)             configs-gateway-1
 23b21f2e570c   yyz1harbor01.netint.ca/bitstreams/mysql:5.7                                           "/opt/bitnami/script…"   3 weeks ago   Up 9 days (healthy)             configs-mysql-1
 da948abfb129   yyz1harbor01.netint.ca/bitstreams/nginx:v1.0.0                                        "/docker-entrypoint.…"   3 weeks ago   Up 9 days (healthy)             configs-nginx-1
 4372bd6d025a   yyz1harbor01.netint.ca/bitstreams/minio:2024.7.15                                     "/opt/bitnami/script…"   3 weeks ago   Up 9 days (healthy)             configs-minio-1
 017a88eaa1f2   yyz1harbor01.netint.ca/bitstreams/etcd:3.5.7                                          "/opt/bitnami/script…"   3 weeks ago   Up 9 days (healthy)             configs-etcd-1
 f7bf25ade084   yyz1harbor01.netint.ca/bitstreams/redis:7.0                                           "/opt/bitnami/script…"   3 weeks ago   Up 9 days (healthy)             configs-redis-endpoint-1
 c5d8554a4f5a   yyz1harbor01.netint.ca/bitstreams/stream-live:release_v2.1.1_RC1                      "./objs/srs -c conf/…"   3 weeks ago   Up 9 days (healthy)             configs-stream-live-1
 1b035588233e   yyz1harbor01.netint.ca/bitstreams/etcdkeeper:v1.0.0                                   "/bin/sh -c './etcdk…"   3 weeks ago   Up 9 days (healthy)             configs-etcdkeeper-1

Access User Interface

1. Log into the Bitstreams Edge User Interface using the server IP that you entered during the installation, eg: http://10.0.100.10.

   info

   Bitstreams Edge has only one default user and currently does not support creating additional users.

   	Username	Password
   Bitstreams Edge UI	[email protected]	user.Bitstreams.NETINT

   warning

   It is recommended to change the default password.

User Guide

User Guide

Bitstreams Edge User Guide.