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 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 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

   Installing on Akamai

   If you are installing Bitstreams on VM hosted by Akamai, you will need to skip the firmware upgrade with the --skip-firmware-upgrade parameter.

   ./edge_quick_installer.py <ipv4Addr> {http,https} --skip-firmware-upgrade

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:

[+] Running 12/12
✔ Container configs-stream-live-1             Started             0.6s
✔ Container configs-redis-endpoint-1          Healthy             11.1s
✔ Container configs-etcd-1                    Healthy             31.7s
✔ Container configs-nginx-1                   Started             0.6s
✔ Container configs-mysql-1                   Healthy             31.1s
✔ Container configs-minio-1                   Started             0.6s
✔ Container configs-gateway-1                 Started             0.6s
✔ Container configs-db-migration-1            Started             31.0s
✔ Container configs-stream-trans-1            Healthy             31.5s
✔ Container configs-lms-1                     Healthy             42.0s
✔ Container configs-nvs-1                     Healthy             51.7s
✔ Container configs-notification-1            Started             51.8s

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
03628d769bc3   yyz1harbor01.netint.ca/bitstreams/notification:release_v2.6.0_RC1                      "./notification --co…"   About an hour ago   Up 59 minutes (healthy)                configs-notification-1
4aed9a82e6b4   yyz1harbor01.netint.ca/bitstreams/nvs:release_v2.6.0_RC1                               "./nvs --config conf…"   About an hour ago   Up 59 minutes (healthy)                configs-nvs-1
6a034c68c95a   yyz1harbor01.netint.ca/bitstreams/lms:release_v2.6.0_RC3-bqe                           "./lms --config conf…"   About an hour ago   Up About an hour (healthy)             configs-lms-1
18ed17e1cafd   yyz1harbor01.netint.ca/bitstreams/stream-trans:release_v2.6.0_RC3-release_v2.6.0_RC3   "./stream-trans --co…"   About an hour ago   Up About an hour (healthy)             configs-stream-trans-1
1a82bc0b17d5   yyz1harbor01.netint.ca/bitstreams/gateway:release_v2.6.0_RC3-release_v2.6.0_RC3-bqe    "/bin/sh -c 'crond &…"   About an hour ago   Up About an hour (healthy)             configs-gateway-1
2388d90f7f63   yyz1harbor01.netint.ca/bitstreams/mysql:8.0                                            "/opt/bitnami/script…"   About an hour ago   Up About an hour (healthy)             configs-mysql-1
0978fc06bb5b   yyz1harbor01.netint.ca/bitstreams/nginx:1.26.3                                         "/docker-entrypoint.…"   About an hour ago   Up About an hour (healthy)             configs-nginx-1
5f74c93dc08c   yyz1harbor01.netint.ca/bitstreams/minio:2024.7.15                                      "/opt/bitnami/script…"   About an hour ago   Up About an hour (healthy)             configs-minio-1
918d3b6c1d6c   yyz1harbor01.netint.ca/bitstreams/stream-live:release_v2.6.0_RC1                       "./start_srs.sh"         About an hour ago   Up About an hour (healthy)             configs-stream-live-1
37cc2d221567   yyz1harbor01.netint.ca/bitstreams/etcd:3.5.7                                           "/opt/bitnami/script…"   About an hour ago   Up About an hour (healthy)             configs-etcd-1
8014a24e616d   yyz1harbor01.netint.ca/bitstreams/redis:7.2.5                                          "/opt/bitnami/script…"   2 weeks ago         Up About an hour (healthy)             configs-redis-endpoint-1

Access User Interface

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

   info

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

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

   warning

   It is recommended to change the default password.

User Guide

User Guide

Bitstreams User Guide.