Keel Platform manual

How to sign in and use the service, administer your organization, and run the site. Pick the part that fits what you do.

For members

  1. Signing in and out
    How to reach your organization's login page, sign in with your password or your organization's identity provider, and sign out again.
  2. Setting your password
    How to set your first password, replace a forgotten one, or change it, using the link the service emails you.
  3. Finding your way around
    What you see after signing in: the dashboard, the header, the left menu, the account and settings menus, and the error page.
  4. Your profile
    How to change the name your colleagues see, choose your time zone, and check how you sign in.
  5. Two-factor authentication
    How to protect your account with a 6-digit code from an authenticator app on your phone, and what to do if you lose the phone.
  6. Staying signed in on a browser
    How to keep a browser you alone use signed in for weeks, and how to forget it again.
  7. Plans and the free trial
    How to compare the plans on sale and start a free trial organization of your own, from the email address to your first sign-in.
  8. The demo application
    What the pages of the demo application shipped with Keel Platform show a member: its dashboard, the notes page and the demo report.

For tenant administrators

  1. Administering your organization
    Where the administration pages are, which of them you can open, and the role a new organization starts with.
  2. People
    How to find, add, deactivate and reactivate the members of your organization, and grant them roles.
  3. Groups
    How to gather members into groups, grant roles to a whole group at once, and keep the membership up to date.
  4. Roles and permissions
    How to define roles, choose what each one permits, and keep the catalog of permissions.
  5. Settings
    How your organization's settings page works: what is set here, what is inherited, and how to change or clear a value.
  6. Name, logo, time zone and mail
    How to set your organization's name, logo and time zone, and send its email through your own mail server.
  7. Sign-in security
    How long a sign-in lasts, how long a password link works, whether members may stay signed in on a browser, and how often signing keys are renewed.
  8. Signing in through an identity provider
    How to let your members sign in with your organization's own identity provider, test it safely, and decide who gets in and with which roles and groups.
  9. Data retention
    How long your organization keeps the personal data of members who left, and the personal details in its audit log.
  10. Billing and licenses
    How your organization's subscription, licenses and automatic renewal work, and which billing emails you receive.
  11. Balance, top-ups and invoices
    How to top up your organization's prepaid balance, read its statement, keep the billing details right, and find your invoices.
  12. The audit log
    How to find out who changed what in your organization, and when.
  13. The encryption key
    How to check and rotate your organization's customer managed key, the key at the top of everything that protects its data.

For site operators

  1. Site administration and the operators
    Where the pages for running the whole site are, which site permission opens each of them, and how the operators tenant decides who is an operator.
  2. Tenants
    How to find a tenant, add and provision a new one, read its status, and change its status and slugs.
  3. Licenses
    How to read a tenant's subscription and licenses, issue a license free of charge or sell one from the prepaid balance, and revoke a license.
  4. Balance, invoices and corrections
    How to read a tenant's prepaid balance and statement, look up its buyer and invoices, and refund part or all of an invoice with a correction.
  5. Letting people back into a tenant
    How to give someone the Tenant Setup Administrator role when a tenant's administrators have lost access, and how to fix or clear a tenant's identity provider that locks its members out.
  6. Service plans
    How to create plans, set their status, arrange them into groups by drag and drop, and choose the plan trials run on.
  7. Plan terms
    What a version of a plan's terms says, how to put new terms on sale, and how to adjust a sale window.
  8. Trials
    How prospects create trial tenants on their own, how to choose the plan trials run on, and how to follow the trial requests.
  9. Bank accounts and statements
    How to register the bank accounts tenants top up, import their bank statements, find transactions, and how payments reach a tenant's balance.
  10. VAT
    How to set the VAT rule for each buyer country and how to read the VAT number checks that decide whether a business buyer is invoiced without VAT.
  11. Site settings
    How the site settings editor works and what each site-level setting controls: the service's identity, the seller and invoicing, mail, security policies and retention.
  12. Audit logs
    How to read and search the site's three audit logs: core, licensing and billing.
  13. The site encryption key
    What the site encryption key protects, how to rotate it, and what to do when a rotation did not finish.
  14. Platform setup and recovery
    When the platform setup page is open, how to enter it with the setup token, and how it brings a new site into use or lets operators back in after they are locked out.