DUST: Device Usage Tracker API

DUST is a tool to track the usage of a fleet of devices in a shared environment.

With DUST, you can:

• Add new devices, providing descriptive information on them, such:
  • hostname
  • brand
  • model
  • credentials
  • photo
  • ip
  • nickname
  • and more...
• Claim a device as a user to let others know which device is in use.
• Integrate a Slack bot with a Slack channel for group communication and convenient commands (like /claim <device>).

Made for PaperCut Constructival 2016

Build Setup

Pre-requisites:

• Maven

# run a local instance on port 9090
mvn exec:java

Configuration

Add your own configuration.yml based on configuration.yml.dist on the top level of the project.

slackConfig
    configuration for the Slack integration

authConfig
    configuration for the user authentication

server
    configuration for the server app and admin connectors

logging
    configuration for the logger

Authentication

DUST uses Google OAuth for authentication and authorisation. To begin, create a Google API Console project and client ID.

The optional hostedDomain may be configured to restrict users to a Google Apps domain.

Slack Integration

Edit configuration.yml and set the values for slackConfig You will need to configure a custom bot user and slash commands for the channels being used. NOTE: Slack integration is optional. Leaving botToken empty will ignore running any Slack operation.

Bot

name: <slackConfig.botUsername>
API token: <slackConfig.botToken>

Slash commands

names: /claim, /unclaim, /list and /show
Token: <slackConfig.commandVerificationTokens> (You can specify more than one)

(post as <slackConfig.botUsername>)

Deploying Changes

Pre-requisites:

• Docker

Build the container

mvn clean package docker:build