Settings reference
Every key the add-on reads, in user/config/plugins/kahunacart-point-of-sale.yaml, with its default. Each has a field on KahunaCart → Point of sale → Settings (the same form as Plugins → KahunaCart Point of Sale in the Grav admin), on four tabs: Till, Look, Staff and Cash.
Where these are edited
KahunaCart → Point of sale → Settings. This is Grav's own configuration form, built from the plugin's blueprint. The Save button in the admin's header saves it.
Important
Settings save where the admin's environment picker says. With the picker on Default that is the base config. With a named environment chosen it is that environment's copy.
The master switch
| Key | Default | Field | What it does |
|---|---|---|---|
enabled |
true |
Plugin status | Off, and the add-on does nothing. /pos isn't served and the POS routes are gone. The permissions stay registered, and your registers, shifts and PINs stay in the database. |
Till
| Key | Default | Field | What it does |
|---|---|---|---|
route |
/pos |
Address | Where the till lives on your site. Open it on the tablet by the counter and add it to the home screen. The plugin serves it itself, so there is no page to make. |
show_tax_on_basket |
true |
Show tax on the basket | Shows the tax line under the basket total. |
receipt_footer |
empty | Receipt footer | A line printed at the foot of every till receipt, like your opening hours or a returns note. |
quick_cash |
{} |
Quick cash notes | The note buttons on the cash screen, per currency, in minor units. USD and 500, 1000, 2000, 5000 gives 5, 10, 20 and 50 dollars. A currency you leave out gets a built-in set that suits it. |
Look
How the till looks: your colour, your logo, and light or dark.
| Key | Default | Field | What it does |
|---|---|---|---|
brand_color |
empty | Brand colour | The colour of the till's buttons and highlights. Leave it empty for the till's own green. |
logo |
none | Logo | An image you upload: PNG, JPG, SVG or WebP. It goes on the sign-in and Who's serving? screens, and small in the bar along the top. With no logo the till looks as it always has. |
logo_dark |
none | Logo for dark mode | A second logo for when the till is dark, for a logo with dark lettering that wouldn't show on a dark background. Leave it empty to use the first one. |
appearance |
device |
Appearance | Follow the device matches the tablet's own light or dark setting and changes with it. Light or Dark keeps the till that way whatever the tablet says. |
How the colour is used
You pick one colour and the till works out the rest, separately for light and for dark:
- The buttons are your colour. A very light colour (a pale yellow, say) is darkened a little in light mode so the button still stands out from the light background. In dark mode the colour is lightened if it needs to be, so a navy reads as a bright blue on the dark background.
- The text on the buttons is white on any colour that isn't genuinely light, so an orange or a navy button keeps white text. If white needs a little more contrast to read, the button is darkened just enough. A light colour such as a yellow gets near-black text instead. In dark mode the buttons are lightened to stand out on the dark ground and take dark text, as the till's own green does.
- Selected things, like the chosen person on the lock screen or the open screen in the menu, get a soft tint of your colour, with text in a shade of it that's readable on that tint.
- The pressed shade is a step darker or lighter, away from the text colour.
- The tablet's status bar and the home-screen icon take the colour too. The icon stays the till drawing on a square tile in your colour. Your logo isn't used as the icon: logos are usually wide, and a home screen wants a square.
Pick the colour of your till green, #0C6B58, and it's the same as leaving it empty.
Note
Uploading a logo uses the admin's file upload, so the account doing it needs to be able to upload media as well as change settings. An owner account can do both.
Staff
| Key | Default | Field | What it does |
|---|---|---|---|
require_pin |
true |
Staff sign in with a PIN | Each person serving picks their name and types their PIN on the till. Off, the account the tablet is signed in as does everything, which suits a one-person shop. See Staff and PINs. |
idle_lock_minutes |
5 |
Lock after (minutes) | The till locks and asks for a PIN after this long without being touched. The sale in progress is kept. 0 never locks. From 0 to 720. |
discount_limit_percent |
100 |
Discount limit (%) | The biggest discount, as a percent of what it comes off, that somebody without the manage permission can give. Anything bigger needs a manager's PIN. From 0 to 100. The default of 100 means no limit. |
Cash
| Key | Default | Field | What it does |
|---|---|---|---|
difference_alert_minor |
{} |
Tell me about a cash difference over | Per currency, in minor units. USD and 500 sends you a message when a shift closes more than 5.00 over or short. A currency you leave out uses 500. |
The Cash tab also points to the two KahunaCart settings below.
Settings the till shares with KahunaCart
These two belong to KahunaCart, because KahunaCart takes the cash and prints the receipt. They are under KahunaCart → Settings → Commerce → Counter Sales, and the Point of sale Settings tab has a button that opens them.
| Key | Default | What it does |
|---|---|---|
pos.cash_rounding |
{} |
The smallest cash coin per currency, in minor units, such as {CHF: 5, CAD: 5, DKK: 50}. The cash that pays the rest of an order is rounded to it. A currency not listed is never rounded. See Taking payment. |
pos.receipt_logo |
empty | A black and white logo for the top of the till receipt. A site-relative path or a URL. Empty prints the store name only. |
Example
enabled: true
route: /pos
require_pin: true
idle_lock_minutes: 5
discount_limit_percent: 15
quick_cash:
USD: '500, 1000, 2000, 5000'
receipt_footer: 'Open Tuesday to Saturday, 10 to 5. Returns within 30 days with this receipt.'
show_tax_on_basket: true
brand_color: '#EA580C'
appearance: device
difference_alert_minor:
USD: 500
CHF: 1000