ServiceFloGuide

ServiceFlo guide

How to install ServiceFlo, keep it running and set it up. These pages are for the person who looks after an install; they assume you can use a terminal, and nothing more.

This is an alpha. ServiceFlo 0.1.0a1 is an early release for trying out. Things will change before 1.0, and these pages cover the essentials only. Take backups (the second page says how) and tell us what is unclear.

The pages

Page What it covers
Install ServiceFlo From nothing to a site you can sign in to: first a trial on your own computer, then a real install with a host name, HTTPS and email.
Your first hour as an administrator From an empty site to a working desk: a workspace, your colleagues, a connected mailbox and a first ticket.
Connect other tools API keys, opening a ticket from another system, webhooks that tell other systems what happened, and approvals given elsewhere.
Single sign-on Letting people sign in on your organisation’s own sign-in page (SAML): what to give your identity provider, what to ask for back, and how to get in if it breaks.
Backups and upgrades Taking backups, putting one back, moving to a new release, and what to do when an upgrade stops.

Going deeper

The rest of the docs/ folder is reference: written for people who run or change ServiceFlo in detail, one page per subject. The ones an administrator reaches for: