chilcote / outset

Automatically process packages, profiles, and scripts during boot, login, or on demand.
572 stars 58 forks source link
launchd macadmin python

Outset

NOTE: This instance of Outset is decommissioned and you should start using the Swift-based Outset 4.0 available on the macadmins repo.

Outset is a script which automatically processes packages, profiles, and scripts during the boot sequence, user logins, or on demand.

Requirements

If you need to support 10.14 or lower, stick with the 2.x version.

python3 can be installed from one of these sources:

If none of these are on disk, then fall back to Apple's system python3, which can be installed via the Command Line Tools.

Outset no longer supports python 2, which was sunsetted on Jan 1, 2020. If you choose to continue to use python 2, you'll want to create the symlink via other means, with something like:

/bin/ln -s /usr/bin/python /usr/local/outset/python3

Usage

usage: outset [-h]
            (--boot | --login | --login-privileged | --on-demand | --login-every | --login-once | --cleanup | --version | --add-ignored-user username | --remove-ignored-user username | --add-override scripts | --remove-override scripts)

This script automatically processes packages, profiles, and/or scripts at
boot, on demand, and/or login.

optional arguments:
-h, --help            show this help message and exit
--boot                Used by launchd for scheduled runs at boot
--login               Used by launchd for scheduled runs at login
--login-privileged    Used by launchd for scheduled privileged runs at login
--on-demand           Process scripts on demand
--login-every         Manually process scripts in login-every
--login-once          Manually process scripts in login-once
--cleanup             Used by launchd to clean up on-demand dir
--version             Show version number
--add-ignored-user username
                        Add user to ignored list
--remove-ignored-user username
                        Remove user from ignored list
--add-override scripts
                        Add scripts to override list
--remove-override scripts
                        Remove scripts from override list

See the wiki for info on how to use Outset.

Credits

This script was an excuse for me to try to learn python. I learn best when I can pull apart existing scripts. As such, this script is heavily based on the great work by Nate Walck, Allister Banks, Rich Trouton, Graham Gilbert, and Greg Neagle.

Special thanks to @homebysix for working on the python3 compatibility release.

License

Copyright Joseph Chilcote

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.