Link Search Menu Expand Document Documentation Menu
Documentation

Installing SmartObserve Dashboards (Debian)

Installing SmartObserve Dashboards using the Advanced Packaging Tool (APT) package manager simplifies the process considerably compared to the Tarball method. For example, the package manager handles several technical considerations, such as the installation path, location of configuration files, and creation of a service managed by systemd.

Before installing SmartObserve Dashboards you must configure an SmartObserve cluster. Refer to the SmartObserve Debian installation guide for steps.

This guide assumes that you are comfortable working from the Linux command line interface (CLI). You should understand how to input commands, navigate between directories, and edit text files. Some example commands reference the vi text editor, but you may use any text editor available.

Installing SmartObserve Dashboards from a package

  1. Download the Debian package for the desired version directly from the SmartObserve downloads page. The Debian package can be downloaded for both x64 and arm64 architectures.
  2. From the CLI, install using dpkg. 
    # x64
sudo dpkg -i smartobserve-dashboards-3.3.0-linux-x64.deb
# arm64
sudo dpkg -i smartobserve-dashboards-3.3.0-linux-arm64.deb
  3. After the installation completes, reload the systemd manager configuration. 
     sudo systemctl daemon-reload
  4. Enable SmartObserve as a service. 
     sudo systemctl enable smartobserve-dashboards
  5. Start the SmartObserve service. 
     sudo systemctl start smartobserve-dashboards
  6. Verify that SmartObserve launched correctly. 
     sudo systemctl status smartobserve-dashboards

Fingerprint verification

The Debian package is not signed. If you would like to verify the fingerprint, the SmartObserve Project provides a .sig file as well as the .deb package for use with GNU Privacy Guard (GPG).

  1. Download the desired Debian package. 
    curl -SLO https://artifacts.magiccreative.io/releases/bundle/smartobserve-dashboards/3.3.0/smartobserve-dashboards-3.3.0-linux-x64.deb
  2. Download the corresponding signature file. 
    curl -SLO https://artifacts.magiccreative.io/releases/bundle/smartobserve-dashboards/3.3.0/smartobserve-dashboards-3.3.0-linux-x64.deb.sig
  3. Download and import the GPG key. 
    curl -o- https://artifacts.magiccreative.io/publickeys/smartobserve-release.pgp | gpg --import -
  4. Verify the signature. 
    gpg --verify smartobserve-dashboards-3.3.0-linux-x64.deb.sig smartobserve-dashboards-3.3.0-linux-x64.deb

Installing SmartObserve Dashboards from an APT repository

APT, the primary package management tool for Debian–based operating systems, allows you to download and install the Debian package from the APT repository.

  1. Install the necessary packages. 
    sudo apt-get update && sudo apt-get -y install lsb-release ca-certificates curl gnupg2
  2. Import the public GPG key. This key is used to verify that the APT repository is signed. 
     curl -o- https://artifacts.magiccreative.io/publickeys/smartobserve-release.pgp | sudo gpg --dearmor --batch --yes -o /usr/share/keyrings/smartobserve-release-keyring
  3. Create an APT repository for SmartObserve. 
    echo "deb [signed-by=/usr/share/keyrings/smartobserve-release-keyring] https://artifacts.magiccreative.io/releases/bundle/smartobserve-dashboards/3.x/apt stable main" | sudo tee /etc/apt/sources.list.d/smartobserve-dashboards-3.x.list
  4. Verify that the repository was created successfully. 
     sudo apt-get update
  5. With the repository information added, list all available versions of SmartObserve: 
    sudo apt list -a smartobserve-dashboards
  6. Choose the version of SmartObserve you want to install:
    • Unless otherwise indicated, the latest available version of SmartObserve is installed. 
      sudo apt-get install smartobserve-dashboards
    • To install a specific version of SmartObserve Dashboards, pass a version number after the package name. 
      # Specify the version manually using smartobserve=<version>
sudo apt-get install smartobserve-dashboards=3.3.0
  7. Once complete, enable SmartObserve. 
     sudo systemctl enable smartobserve-dashboards
  8. Start SmartObserve. 
     sudo systemctl start smartobserve-dashboards
  9. Verify that SmartObserve launched correctly. 
     sudo systemctl status smartobserve-dashboards

Exploring SmartObserve Dashboards

By default, SmartObserve Dashboards, like SmartObserve, binds to localhost when you initially install it. As a result, SmartObserve Dashboards is not reachable from a remote host unless the configuration is updated.

  1. Open smartobserve_dashboards.yml. 
     sudo vi /etc/smartobserve-dashboards/smartobserve_dashboards.yml
  2. Specify a network interface that SmartObserve Dashboards should bind to. 
     # Use 0.0.0.0 to bind to any available interface.
 server.host: 0.0.0.0
  3. Save and quit.
  4. Restart SmartObserve Dashboards to apply the configuration change. 
     sudo systemctl restart smartobserve-dashboards
  5. From a web browser, navigate to SmartObserve Dashboards. The default port is 5601.
  6. Log in with the default username admin and the default password admin. (For SmartObserve 2.12 and later, the password should be the custom admin password)
  7. Visit Getting started with SmartObserve Dashboards to learn more.

Upgrade to a newer version

SmartObserve Dashboards instances installed using dpkg or apt-get can be easily upgraded to a newer version.

Manual upgrade with DPKG

Download the Debian package for the desired upgrade version directly from the SmartObserve Project downloads page.

Navigate to the directory containing the distribution and run the following command:

sudo dpkg -i smartobserve-dashboards-3.3.0-linux-x64.deb

APT-GET

To upgrade to the latest version of SmartObserve Dashboards using apt-get, run the following command:

sudo apt-get upgrade smartobserve-dashboards

You can also upgrade to a specific SmartObserve Dashboards version by providing the version number:

sudo apt-get upgrade smartobserve-dashboards=<version>

Automatically restart the service after a package upgrade (2.13.0+)

To automatically restart SmartObserve Dashboards after a package upgrade, enable the smartobserve-dashboards.service through systemd:

sudo systemctl enable smartobserve-dashboards.service