Install Rudder agent on Debian or Ubuntu

If you are working on a test system, you can use the quick install script:

curl https://repository.rudder.io/tools/rudder-setup | bash -s setup-agent 8.1 [policy server hostname or ip]

That will automatically execute the following steps.

Installation

Each official package is signed with our GPG signature. To ensure the packages you will install are official builds and have not been altered, import our key into apt using the following command:

wget --quiet -O /etc/apt/trusted.gpg.d/rudder_apt_key.gpg "https://repository.rudder.io/apt/rudder_apt_key.gpg"

Our key fingerprint is:

pub  4096R/474A19E8 2011-12-15 Rudder Project (release key) <security@rudder-project.org>
      Key fingerprint = 7C16 9817 7904 212D D58C  B4D1 9322 C330 474A 19E8

On ancient versions (before Debian 7 and before Ubuntu 10.04), you need to use the apt-key tool instead:

wget --quiet -O- "https://repository.rudder.io/apt/rudder_apt_key.pub" | sudo apt-key add -

Add Rudder’s package repository:

# If lsb_release is not installed on your machine, change $(lb_release -cs) by your distribution codename.
# Ex:
#   stretch for Debian 9
#   bionic  for Ubuntu 18.04 LTS

echo "deb [arch=$(dpkg --print-architecture)] http://repository.rudder.io/apt/8.1/ $(lsb_release -cs) main" > /etc/apt/sources.list.d/rudder.list

If you have an active subscription, use the following to get access to long term support. You need to replace the username (LOGIN) and the password (PASSWORD) by your Rudder account:

echo "deb [arch=$(dpkg --print-architecture)] https://download.rudder.io/apt/8.1/ $(lsb_release -cs) main" > /etc/apt/sources.list.d/rudder.list

# for recent debian (>=10) and ubuntu (>=20)
echo 'machine download.rudder.io login LOGIN password PASSWORD' > /etc/apt/auth.conf.d/rudder.conf
chmod 640 /etc/apt/auth.conf.d/rudder.conf

# on old debian (<10) and ubuntu (<20) use this instead
#echo 'machine download.rudder.io login LOGIN password PASSWORD' >> /etc/apt/auth.conf
#chmod 640 /etc/apt/auth.conf

Update your local package database to retrieve the list of packages available in our repository:

apt-get update

Install the package:

apt-get install rudder-agent

Configuration

Configure the agent

Configure the IP address or hostname of the Rudder Root Server in the following file

rudder agent policy-server <rudder server ip or hostname>

We advise you to use the IP address of the Rudder root server. The DNS name of this server can also be used if you have a trusted DNS infrastructure with proper reverse resolutions.

Add the node to the server

Several minutes after the start of the agent, the new node should be pending in the Rudder web interface. You will be able to browse its inventory, and accept it to manage its configuration with Rudder.

You may force the agent to run and send an inventory by issuing the following command:

rudder agent inventory

You may force the agent run by issuing the following command:

rudder agent run

By default, a node listens on port 5309 to allow remote agent trigger. This feature is optional and can be disabled for security reason.

← with a separate DB on RHEL/CentOS/Amazon Linux →