diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..243f5c9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Jacob Burley, Kai Obendrauf + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index b789822..6123f1b 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,9 @@ # nudge-auto-updater `nudge-auto-updater` is a tool that leverages [SOFA](https://sofa.macadmins.io) in combination with [VulnCheck](https://docs.vulncheck.com/) to detect new macOS updates, triage the severity of the CVEs fixed, and update your JSON [Nudge](https://github.com/macadmins/Nudge) configuration appropriately. -A VulnCheck API key is currently required to use this script - without it, CVE lookups can't be performed. +A [VulnCheck API key](https://vulncheck.com/token/newtoken) is required to use this script - without it, CVE lookups can't be performed. -## Configuration -You can configure this program by putting a `configuration.yml` file in the same directory as the script. -Under the key `targets`, this `configuration.yml` file should contain a list of `osVersionRequirements`, the keys of which are documented below: -| Key | Type | Description | -|-----------------------|--------|----------------------| -| `target` | string | Specifies the `targetedOSVersionsRule` in Nudge. | -| `update_to` | string | Specifies the macOS version this target should update to. This value can be "latest" if the `requiredMinimumOSVersion` should be the latest version of macOS. Otherwise this value can be a major version (e.g. 13), a minor version (e.g. 13.1) or a specific patch version (e.g. 13.1.1). In this case the `requiredMinimumOSVersion` will be set to the newest macOS version with a major version, minor version or patch version less than or equal to the specified value. | +## Getting started +To get started with nudge-auto-updater, you should read the ["Getting Started" page](https://github.com/jc0b/nudge-auto-updater/wiki/Home) in the wiki. -To do: describe rest of keys - -If the `configuration.yml` file is missing this script will only update the Nudge configuration `osVersionRequirements` for the default `targetedOSVersionsRule` to the latest version of macOS. -The specified configuration will only update existing `osVersionRequirements` - it will not create new ones. -An example file is included in this project. \ No newline at end of file +Information about configuring nudge-auto-updater can be found in [the configuration documentation](https://github.com/jc0b/nudge-auto-updater/wiki/Supported-Configuration-Keys). [Examples](https://github.com/jc0b/nudge-auto-updater/wiki/Example-Configurations) are also provided. \ No newline at end of file