SmartCollect SC² documentation / Installation / Install on Debian/Ubuntu

Install on Debian or Ubuntu

This page explains how to install SmartCollect SC² dependencies, download and install SmartCollect SC², get the service up and running on your Debian or Ubuntu system, and also describes the installation package details.

Note on upgrading: While the process for upgrading SmartCollect SC² is very similar to installing SmartCollect SC², there are some key backup steps you should perform. Read Upgrading SmartCollect SC² for tips and guidance on updating an existing installation.

1. Download and install

You can install SmartCollect SC² by downloading a .deb package, or by downloading a binary .tar.gz file.

Install .deb package

If you install the .deb package, then you will need to manually update SmartCollect SC² for each new version.

Copy and paste the code from the installation page into your command line and run. It follows the pattern shown below.

sudo apt-get install -y adduser libfontconfig1
wget <.deb package url>
sudo dpkg -i smartcollect<edition>_<version>_amd64.deb

Install from binary .tar.gz file

Download the latest .tar.gz file and extract it. The files extract into a folder named after the SmartCollect SC² version downloaded. This folder contains all files required to run SmartCollect SC². There are no init scripts or install scripts in this package.

wget <tar.gz package url>
sudo tar -zxvf <tar.gz package>

2. Start the server

This starts the smartcollect-server process as the smartcollect user, which was created during the package installation.

If you installed with the .deb package, then you can start the server using systemd or init.d. If you installed a binary .tar.gz file, then you need to execute the binary.

Start the server with systemd

To start the service and verify that the service has started:

sudo systemctl daemon-reload
sudo systemctl start smartcollect-server
sudo systemctl status smartcollect-server

Configure the SmartCollect SC² server to start at boot:

sudo systemctl enable smartcollect-server.service

Start the server with init.d

To start the service and verify that the service has started:

sudo service smartcollect-server start
sudo service smartcollect-server status

Configure the SmartCollect SC² server to start at boot:

sudo update-rc.d smartcollect-server defaults

Execute the binary

The smartcollect-server binary .tar.gz needs the working directory to be the root install directory where the binary and the public folder are located.

Start SmartCollect SC² by running:

./bin/smartcollect-server web

Package details

  • Installs binary to /usr/sbin/smartcollect-server
  • Installs Init.d script to /etc/init.d/smartcollect-server
  • Creates default file (environment vars) to /etc/default/smartcollect-server
  • Installs configuration file to /etc/smartcollect/smartcollect.ini
  • Installs systemd service (if systemd is available) name smartcollect-server.service
  • The default configuration sets the log file at /var/log/smartcollect/smartcollect.log
  • The default configuration specifies a SQLite3 db at /var/lib/smartcollect/smartcollect.db
  • Installs HTML/JS/CSS and other SmartCollect SC² files at /usr/share/smartcollect

Next steps

Refer to the Getting Started guide for information about logging in, setting up data sources, and so on.

Configure SmartCollect SC²

Refer to the Configuration page for details on options for customizing your environment, logging, database, and so on.