https://github.com/LukeTowers/oc-essentialvars-plugin

Adds the app_[url|logo|favicon|name|debug|description] variables to Mail & CMS templates in OctoberCMS
https://github.com/LukeTowers/oc-essentialvars-plugin

Last synced: 3 months ago
JSON representation

Adds the app_[url|logo|favicon|name|debug|description] variables to Mail & CMS templates in OctoberCMS

• Host: GitHub
• URL: https://github.com/LukeTowers/oc-essentialvars-plugin
• Owner: LukeTowers
• License: mit
• Created: 2018-07-06T17:19:07.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-25T05:10:17.000Z (over 1 year ago)
• Last Synced: 2024-07-23T08:18:30.567Z (3 months ago)
• Language: PHP
• Homepage: https://octobercms.com/plugin/luketowers-essentialvars
• Size: 7.81 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-wintercms - LukeTowers.EssentialVars - Adds the `app_[url|logo|favicon|name|debug|description]` variables to Mail & CMS templates. (Uncategorized / Uncategorized)

README

        
# About

Adds support for logging into the backend with Azure Active Directory Single Sign On (SSO) OAuth.

# Installation

To install from the [Marketplace](https://octobercms.com/plugin/luketowers-essentialvars), click on the "Add to Project" button and then select the project you wish to add it to before updating the project to pull in the plugin.

To install from the backend, go to **Settings -> Updates & Plugins -> Install Plugins** and then search for `LukeTowers.EssentialVars`.

To install from [the repository](https://github.com/luketowers/oc-essentialvars-plugin), clone it into **plugins/luketowers/essentialvars** and then run `composer update` from your project root in order to pull in the dependencies.

To install it with Composer, run `composer require luketowers/oc-essentialvars-plugin` from your project root.

# About

This plugin registers the following variables for use in CMS Layouts, Partials, & Pages as well as for use in Mail Templates:

Name | Description

-------- | ---------------

`app_url`: | The URL to the home page of the application

`app_logo`: | The URL to the backend application logo, defaults to the OctoberCMS logo if not set

`app_favicon`: | The URL to the backend application favicon, defaults to the OctoberCMS logo if not set

`app_name`: | The Application Name from the backend BrandSettings

`app_debug`: | The state of the application debug flag

`app_description`: | The Application Tagline from the backend BrandSettings