Skip to main content

Introduction

✨ Welcome to Octory Docs! 💫

Octory is a highly customizable and elegant macOS application to onboard, support and look after your users. In this documentation, you will learn how to edit the .plist configuration file to tailor Octory to your liking.

Octory's purpose is to help you display information and interact with your end-users.
It has two main modes from which you can create the workflow of your dream:

  • It works as a Window like any typical app.
  • Or directly from your Menu Bar.

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​

Download Octory's latest version on the website's download page.
All the changes can be found on the changelog.

Compatibility​

Octory 3.1.0 and higher requires macOS 26 and higher.
Octory is a Universal Build and runs on both Intel and Apple Silicon.

Tutorials​

You can find tutorials explaining how to configure the application in the Tutorials section.
You can also find some tips to help you configure the application on this page.

Dependencies and Acknowledgments​

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

  • BooleanExpressionEvaluation: Evaluate a string boolean expression with variables
  • Scout: Reading and writing in JSON, Plist, YAML and XML data made simple when the data format is not known at build time. Swift library and command-line tool.
  • AEXML: Simple and lightweight XML parser written in Swift, used through Scout.
  • Yams: A Swift library for the YAML format, used through Scout.
  • SwiftCSV: CSV parser for Swift, used through Scout.
  • Swift Argument Parser: Straightforward, type-safe argument parsing for Swift, used by the Octo-Notifier command-line tool.

Many thanks to the authors and contributors of those libraries.

note

Octory 3.1.0 dropped the ProcedureKit, SnapKit, XMLParsing and Down libraries. The interface no longer uses a layout DSL, XML encoding for API requests and Markdown rendering are now handled natively, and asynchronous work uses Swift Concurrency.

Last updated on