Installation

Manual Installation

See the download page to download the packages.

Debian/Ubuntu

Install the GPG public key: 

wget -q https://sensu.global.ssl.fastly.net/apt/pubkey.gpg -O- | sudo apt-key add -

Determine the codename of the Ubuntu/Debian release on your system: 

. /etc/os-release && echo $VERSION
"14.04.4 LTS, Trusty Tahr" # codename for this system is "trusty"

Create an APT configuration file at /etc/apt/sources.list.d/sensu.list: 

export CODENAME=your_release_codename_here # e.g. "trusty"
echo "deb     https://sensu.global.ssl.fastly.net/apt $CODENAME main" | sudo tee /etc/apt/sources.list.d/sensu.list

Update APT: 

sudo apt-get update

Install Uchiwa: 

sudo apt-get install uchiwa

RHEL/CentOS

Create the YUM repository configuration file for the Sensu Core repository at /etc/yum.repos.d/sensu.repo: 

echo '[sensu]
name=sensu
baseurl=https://sensu.global.ssl.fastly.net/yum/$releasever/$basearch/
gpgcheck=0
enabled=1' | sudo tee /etc/yum.repos.d/sensu.repo

Install Sensu: 

sudo yum install sensu

Using Configuration Management

Chef: uchiwa-chef
Puppet: puppet-uchiwa
Ansible: ansible-uchiwa
SaltStack: sensu-formula

Using Docker

Uchiwa comes pre-packaged in a Docker container for easy deployment.

Download the official Uchiwa Docker image: 

docker pull uchiwa/uchiwa

Create a folder that will contain the configuration files: 

mkdir ~/uchiwa-config

Create and adjust the main configuration file: 

vi ~/uchiwa-config/config.json

Start the Docker container: 

docker run -d -p 3000:3000 -v ~/uchiwa-config:/config uchiwa/uchiwa

Browse Uchiwa: 

http://localhost:3000

From Source

Note

This documentation provides instructions for advanced users who want to build their own packages. Otherwise, we highly recommend to use the system packages in order to get stable releases and an easier installation experience.

Prerequisites

Backend

Download the source code: 

go get -d github.com/sensu/uchiwa && cd $GOPATH/src/github.com/sensu/uchiwa

Build the Uchiwa binary: 

go build -o build/uchiwa . # Build for your current system
GOOS=linux GOARCH=amd64 go build -o build/uchiwa . # Cross Compilation, see Go documentation

Front-end Assets

Install the front-end assets: 

npm install --production # Standard user
npm install --production --unsafe-perm # Root user

Building package in docker

To get uchiwa packages (both rpm and deb), please follow the below steps: 

# clone and go to the uchiwa project root
$ cd uchiwa
# Build docker images for building packages:
$ docker build ./build/ -t sensu_builder
# ensure you have tag on the commit from which packages should be built, please check build/travis.sh for details
# run build
$ docker run --rm -it \
  -v $(pwd):/go/src/github.com/sensu/uchiwa \
  -v /tmp/sensu_packages:/tmp/assets/pkg/s3 \
  -w /go/src/github.com/sensu/uchiwa sensu_builder ./build/travis.sh
# get packages from /tmp/sensu_packages

Note

Please note, within docker we build statically linked executable (CGO_ENABLED=0)

Running Uchiwa Locally

Adjust your configuration: 

cp config.json.example config.json

Start Uchiwa 

./build/uchiwa

Developping

See the Contributing documentation.