Skip to content

Commit df8b968

Browse files
committed
readme formatting
1 parent 9d3f560 commit df8b968

1 file changed

Lines changed: 8 additions & 10 deletions

File tree

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,21 @@ If you plan on using [AutoPkg](https://github.com/autopkg/autopkg), release 2.2
88

99
1. Place `SimpleMDMRepo.py` in the `/usr/local/munki/munkilib/munkirepo/` folder.
1010

11-
## Usage
11+
## API Key
1212

13-
### API Key
14-
15-
#### Generating a Key
13+
### Generating a Key
1614

1715
API keys may be generated within the API section of the SimpleMDM administrator interface. Be sure to grant the key permission for Munki plugin activity.
1816

19-
#### Setting the Key
17+
### Setting the Key
2018

2119
The plugin attempts to fetch the API key three ways, in order:
2220

2321
1. environment variable
2422
1. configuration file
2523
1. interactively
2624

27-
##### Environment Variable
25+
#### Environment Variable
2826

2927
You may set the key once per terminal session like so:
3028

@@ -38,7 +36,7 @@ You can also set the key for a single command by prepending it like so:
3836
SIMPLEMDM_API_KEY="Whvop7kWXxsva326ABDF8VDCSGFyEkuEx2xGgj4jab8AE90cn70QdBTq0fplli0a" autopkg run ...
3937
```
4038

41-
##### Configuration File
39+
#### Configuration File
4240

4341
You may store the key in a configuration file at `/usr/local/simplemdm/munki-plugin/config.plist`. Please scope the permissions on this file so that it is restricted, however still allowing utilities using the repo plugin to access it.
4442

@@ -55,7 +53,7 @@ The file should be formatted as below. Be sure to provide your own API key:
5553
</plist>
5654
```
5755

58-
### Using AutoPkg
56+
## Using AutoPkg
5957

6058
Any `.munki` recipe is supported. In this case, we are importing `GoogleChrome.munki`. Be sure to include `extract_icon` if you'd like the icon uploaded to SimpleMDM, if available.
6159

@@ -65,15 +63,15 @@ Any `.munki` recipe is supported. In this case, we are importing `GoogleChrome.m
6563
autopkg run -v GoogleChrome.munki -k MUNKI_REPO_PLUGIN="SimpleMDMRepo" -k extract_icon=True
6664
```
6765

68-
### Using munkiimport and manifestutil
66+
## Using munkiimport and manifestutil
6967

7068
**Please Note:** Running makecatalogs is not necessary. See "Using Makecatalogs" below for more information.
7169

7270
Before using either of these tools, they must be configured by running `munkiimport --configure` or `manifestutil --configure`. Keep all settings default, except:
7371
- Set repo url to `BLANK` or some other dummy value, as it is unused.
7472
- Set the repo plugin to `SimpleMDMRepo`
7573

76-
### Munki Catalog Notes
74+
## Munki Catalog Notes
7775

7876
### Assignment Groups in lieu of Catalogs
7977

0 commit comments

Comments
 (0)