diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bcfd5bd0..a9c16eee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,7 @@ username=groob # add your remote/upstream git remote add $username git@github.com:groob/micromdm.git -# update from origin/master +# update from origin/main git pull --rebase # create a branch diff --git a/README.md b/README.md index fa919bf4..56b234a1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # MicroMDM - a devops friendly MDM server -[![CircleCI](https://circleci.com/gh/micromdm/micromdm/tree/master.svg?style=svg)](https://circleci.com/gh/micromdm/micromdm/tree/master) +[![CircleCI](https://circleci.com/gh/micromdm/micromdm/tree/main.svg?style=svg)](https://circleci.com/gh/micromdm/micromdm/tree/main) MicroMDM is a Mobile Device Management server for Apple Devices, focused on giving you all the power through an API. @@ -22,4 +22,4 @@ High level overview of the API used for scheduling device actions and processing To help with development, start by reading the [CONTRIBUTING](./CONTRIBUTING.md) document, which has relevant resources. -For a local development environment, or a demo setup, the [ngrok guide](./tools/ngrok/README.md), is the best resource to get something working. \ No newline at end of file +For a local development environment, or a demo setup, the [ngrok guide](./tools/ngrok/README.md), is the best resource to get something working. diff --git a/docs/user-guide/api-and-webhooks.md b/docs/user-guide/api-and-webhooks.md index bc029ee4..e64eae26 100644 --- a/docs/user-guide/api-and-webhooks.md +++ b/docs/user-guide/api-and-webhooks.md @@ -1,6 +1,6 @@ MicroMDM is intended to be a dependency for implementing a higher level workflow. To do so, it exposes all its capabilities through an HTTP API and also forwards all the device responses to an HTTP endpoint of your choice. -For examples of what you can do with the API, reference the [tools/api](https://github.com/micromdm/micromdm/tree/master/tools/api) directory of the micromdm repository. The directory includes executable `curl` examples of API requests which you can run, but also reference when implementing an API client in another language. +For examples of what you can do with the API, reference the [tools/api](https://github.com/micromdm/micromdm/tree/main/tools/api) directory of the micromdm repository. The directory includes executable `curl` examples of API requests which you can run, but also reference when implementing an API client in another language. Throughout this document we will reference the provided scripts as shorthand for making API requests. @@ -219,4 +219,4 @@ Authorization: Basic bWljcm9tZG06c3VwZXJzZWNyZXQ= } ``` -MicroMDM will convert this request into a complete command, and schedule it on the queue. It will then send a push notification to ask the device to check in, and respond with the InstallProfile command. \ No newline at end of file +MicroMDM will convert this request into a complete command, and schedule it on the queue. It will then send a push notification to ask the device to check in, and respond with the InstallProfile command. diff --git a/tools/ngrok/README.md b/tools/ngrok/README.md index dd9e6177..dbd6807c 100644 --- a/tools/ngrok/README.md +++ b/tools/ngrok/README.md @@ -58,7 +58,7 @@ export MICROMDM_ENV_PATH="$(pwd)/env" The server will run on port `8080`. The default configuration is minimal, but you can pass any additional flags as arguments to the script. For example `./tools/ngrok/start_server -http-debug`. 5. Configure the Push certificate and DEP tokens. This is a first time setup only step. -If you already have the `MDM CSR` option in your enterprise portal, [follow](https://github.com/micromdm/micromdm/blob/master/docs/user-guide/quickstart.md#configure-an-apns-certificate) the user guide steps. +If you already have the `MDM CSR` option in your enterprise portal, [follow](https://github.com/micromdm/micromdm/blob/main/docs/user-guide/quickstart.md#configure-an-apns-certificate) the user guide steps. If you don't have access to the enterprise portal, you can get an MDM certificate from [mdmcert.download](https://github.com/micromdm/micromdm/wiki/mdmcert.download) You can also export the device management certificate from [Server.app](https://github.com/micromdm/micromdm/wiki/Export-the-Profile-Manager-Certificate).