Docs

MacOS

Supported Versions

  • Sierra 10.13

Installation

  1. Download and run the latest MacOS installer from https://packages.outlyer.com/stable/macosx/outlyer-agent.pkg

  2. Open in Finder, then right click / Open. You might get an alert that is from unidentified developer, you’ll have to click on open button here.

  3. Grab the Agent Key, which you find under Agent Integration on the Integrations page of the Outlyer application.

  4. After installing the agent the configuration can be found in the installation folder. For more settings see the agent configuration documentation.
    /etc/outlyer/agent.yaml
    
  5. The agent’s log file is under the installation folder.
    /var/log/outlyer/agent.log
    

Upgrades

To upgrade the Outlyer agent, download the latest installer, and install the new package, your previous settings will be used.

Silent Install

echo YOUR-AGENT-KEY > ~/Library/Caches/outlyer-agentKey.txt
sudo installer -pkg outlyer-agent.pkg -target / -verbose
rm ~/Library/Caches/outlyer-agentKey.txt

Silent Upgrade

sudo installer -pkg outlyer-agent.pkg -target / -verbose
sudo launchctl unload /Library/LaunchDaemons/com.outlyer.OutlyerAgent.plist
sudo launchctl load -w /Library/LaunchDaemons/com.outlyer.OutlyerAgent.plist

Starting and Stopping Outlyer agent

The agent is installed as a Global Daemon. You can start or stop the service from the command line:

  • Start:
    sudo launchctl load -w /Library/LaunchDaemons/com.outlyer.OutlyerAgent.plist
    
  • Stop:
    sudo launchctl unload /Library/LaunchDaemons/com.outlyer.OutlyerAgent.plist
    

In addition you can also use the LaunchControl application. You’ll find com.outlyer.OutlyerAgent under Global Daemons.

Uninstalling

You can uninstall and remove the Outlyer agent via:

sudo launchctl unload /Library/LaunchDaemons/com.outlyer.OutlyerAgent.plist
sudo rm -rf /var/log/outlyer /opt/outlyer /etc/outlyer /Library/LaunchDaemons/com.outlyer.OutlyerAgent.plist
# Remove local outlyer user
sudo dscl localhost delete /Local/Default/Users/outlyer