README

A Simple and flexible room reservation status display for e-ink or other non-touch displays using Kirby

Features

• Closing Hour Override per-room
• Per-room toggleable notice text display
• Per-room QR code display dynamically generated through KirbyCMS
• Per-Room description that displays when no upcoming events in timeline
• Ships with integration of LibraryMarket's LibraryCalendar App
• Can use any event calendar app that has JSON event API with some tweaking
• Timeline of upcoming events, hides private event titles but keeps event ID for refrence
• Overflowed events past timeline window are shown at bottom
• Alternative schedule view that shows all events for the day in a static schedule
• Per-Room Color or 2-bit grayscale CSS
• Color picking for color settings for various elements
• Touchscreen option that replaces QR code with reservation button
• Dynamic page scaling tested to work down to 480x360
• Ships with e-paper friendly fonts and CSS configs
• Originally designed to work on a TRMNL device.

Download and Install

This repository only contains the content pages of the site, you will need to download the latest Kirby plainkit seprately.

1. Before Starting, please check that your webserver meets Kirbys minimum requirements listed here and read the provided getting started documentation.
2. Download the latest release of Kirby Plainkit
3. Extract the plainkit to your Website Folder
4. Download the latest release of LibSignTool from the releases page
5. Extract LibSignTool into the plainkit-main folder
6. Some files may ask to be overwritten, approve all overwrites.
7. Make sure hidden files such as .htaccess copied over, as these are required for the site to operate correctly.
8. Start your webserver and navigate to yourdomain.example.com/location-of-kirbycms-install/panel and you will be asked to create an account.
9. After creating the account, you will be able to log in and start adding images to create a campaign. The download includes example pages to get started, but you can edit or remove these pages as long as you replace them with ones using the same or similar templates. Doing more than that will require knowledge of how Kirby works. Examples of what templates do what will be provided later in this document.

Plugins

aag-rooms uses a plugin to keep private API access information safe, to make it work you will either need to remove the code using this plugin, or install this plugin as well (reccomended)

• DotEnv

Backing up and Installing new Versions

Kirby

Kirby is a Flat-file CMS and does not require a database, which makes it very easy to install and backup. Just copy the folder you installed Kirby and aag-rooms to into your backup location to back it up.

To upgrade Kirby, simply download the newest version of the plainkit, Delete the "kirby" and "media" folders from your install folder, and copy the new versions from the plainkit into the folder. Always refer to the offical Kirby documentation for upgrade instructions as these are subject to change between releases.

aag-rooms is built on Kirby 5. Staying within the same generation of releases should be fine, but wait for offical word before upgrading to possible future KirbyCMS generations such as Kirby 6

Kirby 5

Kirby 5 is now fully supported, Kirby 4 has only been tested up to v4.8.0

Licenses

While aag-rooms is provided free under the MIT License, other things in this repository are licensed differently.

Fonts

• Merriweather Sans by SorkinType is licensed under the SIL OPEN FONT LICENSE Version 1.1
• Prompt by Cadson Demak is licensed under the SIL OPEN FONT LICENSE Version 1.1

Kirby

You can try Kirby on your local machine or on a test server as long as you need to make sure it is the right tool for your next project.

However Production use requires a License Key.

Buying a license

You can purchase your Kirby license at https://getkirby.com/buy

A Kirby license is valid for a single domain. You can find Kirby's license agreement here: https://getkirby.com/license

You can learn more about Kirby at getkirby.com.

Kirby Documentation

https://getkirby.com/docs

Kirby Support

https://getkirby.com/support

Issues

We do not develop for Kirby, for issues getting Kirby up and running, please contact that project. We only provide the website content files to host on Kirby to use as a Digital Signage Platform.

If you have a Github account, please report issues directly on Github: https://github.com/salinapl/LibSignTool/issues

Or you can email the maintainers directly at tech.lib@salinapublic.org