Octory Wiki

Welcome to Octory Wiki ! You can learn here how to edit the Plist file to configure Octory.

To have a quick overview of the groups in the Plist file, you can read the Configuration file section.

Octory interface is based on Slides visualization. You can fully customize a slide by setting its containers and the components they contain.

Version

Octory version is currently 2.0.2

Tutorials

You can find tutorials explaining how to configure the application, but also how to deploy it on this page.


Starting Octory

Blank file

Create a folder named Octory in /Library/Application Support. Then copy the blank configuration file inside the created folder and rename it Octory.plist The final path of the file should be /Library/Application Support/Octory/Octory.plist. You can then launch the app.

Presets

You can find several presets folders to rapidly get started with the application. To use one, copy and paste the overall folder of the preset you want to use inside /Library/Application Support/Octory/. Then run the command.

open Octory.app --args -c [PRESET_FOLDER_NAME]/Octory

For example, to use the MenuBar preset, you would run

open Octory.app --args -c MenuBar/Octory

Watch out for spaces which require you to quote the folder name.

Tutorial

The tutorial Getting started with Octory could also be helpful.



Specify the configuration

You can choose the application configuration file by launching it with the configuration argument: -c or --config. The application will then look in the secure folders /Library/Application Support/Octory or /Library/Managed Preferences for the corresponding path.

For example, if you have pushed a custom profile on the Mac named new-config.plist, you can launch Octory like that.

/Library/Application\ Support/Octory/Octory.app/Contents/MacOS/Octory -c new-config

Another example, to use a OctoryTest.plist file in /Library/Application Support/Octory/Configs.

/Library/Application\ Support/Octory/Octory.app/Contents/MacOS/Octory --config Configs/OctoryTest.plist

Last example, to launch Octory with the form preset downloadable from the configurations repository (imagining you have copied the overall Presets folder).

open Octory.app --args -c Presets/Form/Octory

Save the configuration as the default

When using the -c | --configuration option, you can add the --save flag to make Octory save the configuration as the default to use in the User defaults. Thus, when you do not specify a configuration, the saved one will be used rather than the default Octory.plist file. For example:
open Octory.app --args -c Presets/Form/Octory --save

Logs

You can find Octory log at /tmp/[username]-Octory.log. It is dynamically filled with Octory logs to inform you about several things on the running session of the application. One of the best solutions is to use it with the Console app to watch Octory behavior.

Another log is written at /Library/Logs/Octory/octory.log with less info but persistent. Useful for crash reports.


Dependencies and Acknowledgments

Here is the list of the open-source libraries used within Octory.

Many thanks to the authors and contributors of those libraries.


Syntax highlighting

Octory uses the open-source library Lux to colorise the code blocks.