Skip to main content
Version: v3.0.0

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

  1. Install the following required dependencies

    sudo apt install -y unzip nvme-cli sysfsutils

Install Docker​

  1. Install Docker using the apt repository as per the instructions provided by Docker

    warning

    If docker has not been installed, or installed incorrectly the Bitstreams Manager will not properly start.

  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: x86_64 / amd64 

    wget https://releases.netint.com/bitstreams-manager/v3.0.0/Bitstreams_Manager_v3.0.0_x86.zip

  2. Extract the software package and enter the directory.

    unzip Bitstreams_Manager_v3.0.0_x86.zip
    cd  ~/Bitstreams_Manager_v3.0.0_x86

Install Script​

  1. Use the quick install script as shown below:

    warning

    The quick install script requires Python 3.8+

    # Basic usage
    ./bitstreams_manager_quick_install.py <ipv4Addr> {http,https}

    # Example installation
    ./bitstreams_manager_quick_install.py 10.0.100.10 http

    # For advanced features and to view all options
    ./bitstreams_manager_quick_install.py -h

  2. Run the installation script using the basic install process ./bitstreams_manager_quick_install.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 something similar to ths:

    Starting Bitstreams services...
    [+] up 13/13
    ✔ Volume configs_shared-tmpfs        Created                                                                                                                                                                                                                                                                                                                           0.0s
    ✔ Container configs-mysql-1          Healthy                                                                                                                                                                                                                                                                                                                          31.9s
    ✔ Container configs-nginx-1          Created                                                                                                                                                                                                                                                                                                                           1.2s
    ✔ Container configs-gateway-1        Created                                                                                                                                                                                                                                                                                                                           1.2s
    ✔ Container configs-etcd-1           Healthy                                                                                                                                                                                                                                                                                                                          32.4s
    ✔ Container configs-redis-endpoint-1 Healthy                                                                                                                                                                                                                                                                                                                          11.9s
    ✔ Container configs-stream-live-1    Created                                                                                                                                                                                                                                                                                                                           1.2s
    ✔ Container configs-minio-1          Created                                                                                                                                                                                                                                                                                                                           1.2s
    ✔ Container configs-stream-trans-1   Healthy                                                                                                                                                                                                                                                                                                                          31.2s
    ✔ Container configs-db-migration-1   Created                                                                                                                                                                                                                                                                                                                           0.0s
    ✔ Container configs-lms-1            Healthy                                                                                                                                                                                                                                                                                                                          41.8s
    ✔ Container configs-nvs-1            Healthy                                                                                                                                                                                                                                                                                                                          51.8s
    ✔ Container configs-notification-1   Created  

    Completed.

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

CONTAINER ID   IMAGE                                                                                    COMMAND                  CREATED        STATUS                  PORTS     NAMES
a9b7e39e322e   yyz1harbor01.netint.ca/bitstreams/notification:release_v2.10.0_RC1                       "./notification --co…"   24 hours ago   Up 24 hours (healthy)             configs-notification-1
865c5156ec83   yyz1harbor01.netint.ca/bitstreams/nvs:release_v2.10.0_RC1                                "./nvs --config conf…"   24 hours ago   Up 24 hours (healthy)             configs-nvs-1
db0ba081df52   yyz1harbor01.netint.ca/bitstreams/lms:release_v2.10.0_RC2-bqe                            "./lms --config conf…"   24 hours ago   Up 24 hours (healthy)             configs-lms-1
5d8dcb170fa1   yyz1harbor01.netint.ca/bitstreams/stream-trans:release_v2.10.0_RC2-release_v2.10.0_RC2   "./stream-trans --co…"   24 hours ago   Up 24 hours (healthy)             configs-stream-trans-1
012c0f2e8dac   yyz1harbor01.netint.ca/bitstreams/gateway:release_v2.10.0_RC1-release_v2.10.0_RC2-bqe    "/bin/sh -c 'crond &…"   24 hours ago   Up 24 hours (healthy)             configs-gateway-1
f980e041f293   yyz1harbor01.netint.ca/bitstreams/nginx:1.26.3                                           "/docker-entrypoint.…"   24 hours ago   Up 24 hours (healthy)             configs-nginx-1
cb377dd6b167   yyz1harbor01.netint.ca/bitstreams/redis:7.2.5                                            "/opt/bitnami/script…"   24 hours ago   Up 24 hours (healthy)             configs-redis-endpoint-1
a58514f4481b   yyz1harbor01.netint.ca/bitstreams/mysql:8.0                                              "/opt/bitnami/script…"   24 hours ago   Up 24 hours (healthy)             configs-mysql-1
9215f96c56ff   yyz1harbor01.netint.ca/bitstreams/stream-live:release_v2.10.0_RC1                        "./start_srs.sh"         24 hours ago   Up 24 hours (healthy)             configs-stream-live-1
72b86c8322d7   yyz1harbor01.netint.ca/bitstreams/minio:2024.7.15                                        "/opt/bitnami/script…"   24 hours ago   Up 24 hours (healthy)             configs-minio-1
cbfb39fb22d8   yyz1harbor01.netint.ca/bitstreams/etcd:3.5.7                                             "/opt/bitnami/script…"   24 hours ago   Up 24 hours (healthy)             configs-etcd-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.

    UsernamePassword
    Bitstreams UI[email protected]user.Bitstreams.NETINT
    warning

    It is recommended to change the default password.

Enroll a Server​

The final step is to enroll a server. Details are found on the Servers page.

User Guide​

User Guide

User Guide

Bitstreams Manager User Guide.