https://github.com/micromdm/nanomdm

NanoMDM is a minimalist Apple MDM server and library heavily inspired by MicroMDM
https://github.com/micromdm/nanomdm

Last synced: 4 days ago
JSON representation

NanoMDM is a minimalist Apple MDM server and library heavily inspired by MicroMDM

• Host: GitHub
• URL: https://github.com/micromdm/nanomdm
• Owner: micromdm
• License: mit
• Created: 2021-05-02T18:37:27.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-01T22:47:07.000Z (about 1 month ago)
• Last Synced: 2024-12-01T08:05:14.344Z (12 days ago)
• Language: Go
• Homepage:
• Size: 363 KB
• Stars: 235
• Watchers: 18
• Forks: 47
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-mdm-dev - NanoMDM - A minimalist open source Apple MDM server heavily inspired by MicroMDM (Tools :hammer_and_wrench:)

README

        
# NanoMDM

[![CD/CD](https://github.com/micromdm/nanomdm/workflows/CI%2FCD/badge.svg)](https://github.com/micromdm/nanomdm/actions) [![Go Reference](https://pkg.go.dev/badge/github.com/micromdm/nanomdm.svg)](https://pkg.go.dev/github.com/micromdm/nanomdm)

NanoMDM is a minimalist [Apple MDM](https://developer.apple.com/documentation/devicemanagement) server and library heavily inspired by [MicroMDM](https://github.com/micromdm/micromdm).

## Getting started & Documentation

- [Quickstart](docs/quickstart.md)  

A quick guide to get NanoMDM up and running using ngrok.

- [Operations Guide](docs/operations-guide.md)  

A brief overview of the various command-line switches and HTTP endpoints and APIs available to NanoMDM.

## Getting the latest version

* Release `.zip` files containing the server and supplementals should be attached to every [GitHub release](https://github.com/micromdm/nanomdm/releases).

  * Release zips are also [published](https://github.com/micromdm/nanomdm/actions) for every `main` branch commit.

* A Docker container is built and [published to the GHCR.io](http://ghcr.io/micromdm/nanomdm) registry for every release.

  * `docker pull ghcr.io/micromdm/nanomdm:latest` — `docker run ghcr.io/micromdm/nanomdm:latest`

  * A Docker container is also published for every `main` branch commit (and tagged with `:main`)

* If you have a [Go toolchain installed](https://go.dev/doc/install) you can checkout the source and simply run `make`.

## Features

- Horizontal scaling: zero/minimal local state. Persistence in storage layers. MySQL and PostgreSQL backends provided in the box.

- Multiple APNs topics: potentially multi-tenant.

- Multi-command targeting: send the same command (or pushes) to multiple enrollments without individually queuing commands.

- Migration endpoint: allow migrating MDM enrollments between storage backends or (supported) MDM servers

- Otherwise we share many features between MicroMDM and NanoMDM, such as:

  - A MicroMDM-emulating HTTP webhook/callback.

  - Enrollment-certificate authorization

  - API-driven interaction (queuing of commands, APNs pushes, etc.)

## $x not included

NanoMDM is but one component for a functioning MDM server. At a minimum you need a SCEP server and TLS termination, for example. If you've used [MicroMDM](https://github.com/micromdm/micromdm) before you might be interested to know what NanoMDM does *not* include, by way of comparison.

- SCEP.

  - Spin up your own [scep](https://github.com/micromdm/scep) server. Or bring your own.

- TLS.

  - You'll need to provide your own reverse proxy/load balancer that terminates TLS.

- ADE (DEP) API access.

  - While ADE/DEP *enrollments* are supported there is no DEP API access.

- Enrollment (Profiles).

  - You'll need to create and serve your own enrollment profiles to devices.

- Blueprints.

  - No 'automatic' command sending upon enrollment. Entirely driven by webhook or other integrations.

- JSON command API.

  - Commands are submitted in raw Plist form only. See the [cmdr.py tool](tools/cmdr.py) that helps generate raw commands

  - The [micro2nano](https://github.com/micromdm/micro2nano) project provides an API translation server between MicroMDM's JSON command API and NanoMDM's raw Plist API.

- VPP.

- Enrollment (device) APIs.

  - No ability, yet, to inspect enrollment details or state.

  - This is partly mitigated by the fact that both the `file` and `mysql` storage backends are "easy" to inspect and query.

## Architecture Overview

NanoMDM, at its core, is a thin composable layer between HTTP handlers and a set of storage abstractions.

- The "front-end" is a set of standard Golang HTTP handlers that handle MDM and API requests. The core MDM handlers adapt the requests to the service layer. These handlers exist in the `http` package.

- The service layer is a composable interface for processing and handling MDM requests. The main NanoMDM service dispatches to the storage layer. These services exist under the `service` package.

- The storage layer is a set of interfaces and implementations that store & retrieve MDM enrollment and command data. These exist under the `storage` package.

You can read more about the architecture in the blog post [Introducing NanoMDM](https://micromdm.io/blog/introducing-nanomdm/).