Octory comes in different shapes and flavors. For more flexibility during deployement, we offer three choices when it comes to Octory.
- Octory (.pkg)
- Octory with Launch Agent (.pkg)
- Octory standalone (.app)
All packages are included in the zip file which can be grabbed from Octory's download page.
We recommend using Octory's main package as it installs all necessary files in the system, including the Helper and the command-line tool Octo-Notifier.
If you want to have full control over what is installed, we suggest looking at Creating an Octory bootstrap package.
Octory packages do not come with a pre-configured configuration file. If you try to launch the app after installing the package, the application will fail to launch.
Create your configuration file
Now that Octory is installed, you should have a folder named Octory in
Copy the blank configuration file inside the created folder and rename it
The final path should be the System's Library
NOT the User's Library
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
Give the proper permissions to our config file.
sudo chown "`whoami`":admin Octory.plist
sudo chmod 644 Octory.plist
If you do not want to start from a blank configuration file, we have created presets which can be found in the Presets folder of our public GitLab to rapidly get started with the application.
To use one, copy and paste the preset's folder you want to use inside
Launch the App
By default, the application will look for a configuration file named
/Library/Application Support/Octory/ or
/Library/Managed Preferences/. You have two possibilites when it comes to launching the app.
cd /Library/Application\ Support/Octory
The second command will launch Octory and display the logs in real time in the terminal. It is very useful when debugging or building your workflow.
Launch Octory with a specific config file
You can choose to launch Octory with a specific configuration file by launching it with the configuration argument:
For example, if you pushed via your MDM a custom profile named
custom-octory-config.plist, it will be placed inside
/Library/Managed Preferences/. You can then launch Octory with that custom profile using:
/Library/Application\ Support/Octory/Octory.app/Contents/MacOS/Octory -c custom-octory-config.plist
Another example, if you used an
OctoryTest.plist file in
open Octory.app --args -c Configs/OctoryTest.plist
If your custom Octory config is in a subfolder, watch out for spaces in the path.
If you previously downloaded the preset folder, you would simply have to run the following command:
open Octory.app --args -c Presets/PRESET_FOLDER_NAME/Octory.plist
Change the default configuration file
When using the
--config option, you can add the
--save flag to overwrite the default configuration file.
open Octory.app --args -c Configs/OctoryTest.plist --save
Next time you launch the app, if you do not specify a configuration file, the saved one will be used rather than the default