Skip to content

Commit

Permalink
Add "how to get" to README and QuickStart
Browse files Browse the repository at this point in the history
  • Loading branch information
jessepeterson committed Aug 21, 2023
1 parent 3ebc4a0 commit 40e7c16
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@ Please read this README before proceeding to the quickstart guide. It will lay s
- [Quickstart](docs/quickstart.md)
A guide to get KMFDDM up and running quickly.

## Getting the latest version

* Release `.zip` files containing the server and scripts should be attached to every [GitHub release](https://github.com/jessepeterson/kmfddm/releases).
* Release zips are also [published](https://github.com/jessepeterson/kmfddm/actions) for every `main` branch commit.
* A Docker container is built and [published to the GHCR.io](http://ghcr.io/jessepeterson/kmfddm) registry for every release.
* `docker pull ghcr.io/jessepeterson/kmfddm:latest``docker run ghcr.io/jessepeterson/kmfddm: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`.

## Concepts & Terms

### Declaration
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ For this guide you'll need to:
1. Have a working NanoMDM v0.3.0+ or MicroMDM v1.11.0+ environment setup and running with devices able to enroll.
1. Have a compatible device like iOS 15.0+ or macOS Ventura 13.0+ enrolled into your NanoMDM environment. **You'll need to know the enrollment ID of the device(s).**
1. Take note of your MDM server's command enqueue HTTP endpoint and API key (password). For this guide we'll be using `http://[::1]:9000/v1/enqueue` as if you're running NanoMDM locally. For MicroMDM see the [raw command API docs](https://github.com/micromdm/micromdm/blob/main/docs/user-guide/api-and-webhooks.md#schedule-raw-commands-with-the-api).
1. Obtain the KMFDDM server by either downloading a release zip or checking out the code and compiling from source. Take note of where the KMFDDM server binary and the helper scrips are. They're in the [tools](../tools) directory in the source repository — but should also be in the binary release zip.
1. Obtain the KMFDDM server by either downloading a release zip or checking out the code and compiling from source. Note the [README](../README.md) has more details and ways (like Docker) to get the latest version. Take note of where the KMFDDM server binary and the helper scrips are. They're in the [tools](../tools) directory in the source repository — but should also be in the binary release zip.
1. If you're using the `-storage mysql` backend: create and setup the MySQL schema using the [schema file](../storage/mysql/schema.sql) (e.g. creating a new database, users, and executing the `CREATE TABLE` statements). Note the [DSN](https://github.com/go-sql-driver/mysql#dsn-data-source-name) where you created this.

With those steps taken care of we can now start the KMFDDM server.
Expand Down

0 comments on commit 40e7c16

Please sign in to comment.