Administration

Mail and text messages

The settings on the shop PC that let the day's figures reach the owner by e-mail and by SMS through Hubtel.

The figures go out by two channels, each set up once in the .env file in the system's folder on the PC. Either can be left blank; a summary then records not configured for that channel and is still kept. Affram sets both up at install; this page is for the owner who wants to know what is on the machine, or to change a setting later.

E-mail

Any mailbox that offers SMTP will do: the shop's Gmail or Outlook account, or a mailbox from the shop's web host.

SPRING_MAIL_HOST=smtp.gmail.com
SPRING_MAIL_PORT=587
SPRING_MAIL_USERNAME=shop@example.com
SPRING_MAIL_PASSWORD=an-app-password
OTCMS_REPORTS_FROM=shop@example.com
OTCMS_REPORTS_ALWAYS_TO=owner@example.com
  • OTCMS_REPORTS_FROM is the address the figures come from. Leaving it blank turns e-mail off.
  • OTCMS_REPORTS_ALWAYS_TO is optional: an address that receives every summary in addition to the owners' own, say the accountant.
With Gmail, create an app password for the shop PC rather than typing the account's real password: Google Account → Security → App passwords. It can be revoked without changing the account's password.

Text messages

Text messages go through Hubtel, a Ghanaian SMS gateway. The shop, or Affram on its behalf, holds a Hubtel account with a sender ID (the name that appears on the phone, up to eleven characters) and a client ID and secret.

HUBTEL_SMS_CLIENT_ID=
HUBTEL_SMS_CLIENT_SECRET=
HUBTEL_SMS_SENDER_ID=

All three are needed for the channel to be on. Each message costs a few pesewas from the Hubtel balance; one owner receiving one text a day is under a cedi a month. Top the balance up on Hubtel's site.

Who receives

Every enabled person with the Owner / Admin role, at the e-mail and phone on their account, plus the shop's e-mail and phone from Compliance. Phone numbers are Ghanaian: 024 000 0000 and +233 24 000 0000 are the same number.

Changing a setting

Edit .env, then restart the system from its folder:

docker compose up -d

Then send a past day again from Sales by day and check its delivery under Sales summaries.

.env holds passwords. It stays on the PC, it is never e-mailed, and it is not part of the backup dump. Keep a copy of it with the backup drive, in the same drawer as the licence.