Skip to content

Latest commit

 

History

History
82 lines (59 loc) · 3.77 KB

README.md

File metadata and controls

82 lines (59 loc) · 3.77 KB

Build Status codecov Go Report Card Docker pulls

Mender: Device Inventory Service

Mender is an open source over-the-air (OTA) software updater for embedded Linux devices. Mender comprises a client running at the embedded device, as well as a server that manages deployments across many devices.

This repository contains the Mender Device Inventory Service, which is part of the Mender server. The Mender server is designed as a microservices architecture and comprises several repositories.

The Device Inventory Service stores attributes about devices reported by Mender clients, and supports searching and sorting of attributes. In general, the reported attributes are freely defined by the device vendor, and can be used to group devices - based on selected criteria - into groups for which independent deployments can be rolled out.

Mender logo

Getting started

To start using Mender, we recommend that you begin with the Getting started section in the Mender documentation.

Building from source

As the Mender server is designed as microservices architecture, it requires several repositories to be built to be fully functional. If you are testing the Mender server it is therefore easier to follow the getting started section above as it integrates these services.

If you would like to build the Device Inventory service independently, you can follow these steps:

git clone https://github.com/mendersoftware/inventory.git
cd inventory
go build

Configuration

The service can be configured by:

  • providing configuration file (supports JSON, TOML, YAML and HCL formatting). The default configuration file is provided to be downloaded from config.yaml.
  • setting environment variables. The service will check for a environment variable with a name matching the key uppercased and prefixed with "INVENTORY_". Eg. for "listen" the variable name is "INVENTORY_LISTEN".

Contributing

We welcome and ask for your contribution. If you would like to contribute to Mender, please read our guide on how to best get started contributing code or documentation.

License

Mender is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

Security disclosure

We take security very seriously. If you come across any issue regarding security, please disclose the information by sending an email to [email protected]. Please do not create a new public issue. We thank you in advance for your cooperation.

Connect with us