Skip to content
Branch: master
Go to file
Code

README.md

Unum SDK

This repository contains the open source distribution of Minim's Unum agent and related, cumulatively known as the Unum SDK.

Running the Unum agent requires a Minim Labs developer account. Sign up for an account on the Minim website.

Unum is a cross-platform program and can be built and installed on OpenWrt-compatible devices, as well as Linux x86_64, i386, and armhf architectures.

CircleCI Build Status Latest Release

Getting started

The Unum agent is designed to operate on a network gateway device or wireless access point. Once installed, link your device with the Minim cloud to begin gaining insight into your network.

  • Download a pre-built release for your platform from the Releases page
  • Build the SDK yourself for these supported platforms:
    • OpenWrt: build an installable package for routers running OpenWrt
    • Linux: build Unum for Linux and Linux-like distributions
    • Docker: run a Linux router with Unum in a Docker container
  • For guides and documentation, check out the Unum SDK wiki.

Contributing

Guidelines around contributing to Unum SDK are outlined in CONTRIBUTING.md.

Check the Developer Guide on the wiki for more information on the technical aspects of the SDK.

Get in touch

The Minim team is always happy to chat. Send us a mail at labs@minim.co or visit our website to find out more!

You can’t perform that action at this time.