Getting started checklist
This checklist takes you from a first start of Delegaris to people using it. Each step links to the page that covers it in full. Work through them in order: later steps depend on earlier ones.
Before you start
You need:
- a Linux host with Docker and Docker Compose, or one supported by the Linux package, in AWS or anywhere that can reach the AWS APIs
- the address people will use, ideally
https://behind your reverse proxy or load balancer - rights to create an IAM role in each AWS account you want to manage (or someone who has them)
- for sign-in, either a read-only Active Directory service account, or rights to register an app in Entra ID
The steps
| # | Step | Why it matters | Where to do it |
|---|---|---|---|
| 1 | Run Delegaris with PUBLIC_URL and LOCAL_ADMIN_PASSWORD set | PUBLIC_URL drives cookies, the Entra redirect address and links in messages. The local administrator is how you get in to set everything else up | Docker: .env, see Docker Compose. Linux package: /etc/delegaris/delegaris.env, which the installer fills in, see Linux. Every setting: Configuration |
| 2 | Put it behind HTTPS | Sign-in cookies are only marked secure over https:// | Your reverse proxy or load balancer. See Behind a reverse proxy |
| 3 | Sign in as the local administrator | Every other step is done from the web UI | The sign-in page, as admin. See Local administrator |
| 4 | Give Delegaris its own AWS identity | It assumes a role in each managed account from this one identity | Accounts shows what it has found and how to fix it. See Service identity, and Docker on EC2 if it runs on an EC2 instance |
| 5 | Create the role in each account | The role allows listing, starting, stopping and tagging, and nothing else | CloudFormation in each account. See Member account role |
| 6 | Add the accounts | Nothing is listed until an account is added and its connection tested | Accounts > Add an account, then Test connection. See Adding accounts |
| 7 | Set up sign-in | So people sign in with the account they already have | Settings > Sign-in. See Active Directory or Entra ID |
| 8 | Name your administrators | So someone other than the local administrator can run Delegaris | Settings > Sign-in > Administrators, or Settings > Access > Administrators and auditors. See Administrators and auditors |
| 9 | Decide on two-step sign-in (optional) | A code from an authenticator app after the password, for administrators or everyone | Settings > Sign-in > Two-step sign-in (MFA). See Two-step sign-in |
| 10 | Name the schedule tag | Keeping a machine on works by taking this tag off and putting it back. The default is Schedule | Settings > Schedules. See Schedule tags |
| 11 | Give schedules friendly names and hours (optional) | People see "Office hours" instead of 8-8, and Delegaris knows when each machine normally stops | Settings > Friendly names, or Read from the scheduler…. See Friendly names and Reading from the scheduler |
| 12 | Protect the machines nobody else should touch | Domain controllers, firewalls and bastions stay administrator-only whatever the rules say | Tag them Delegaris = protected in AWS. See Protected resources |
| 13 | Add access rules | Until there is a rule, only administrators can see anything | Settings > Access > Add a rule. See Access rules |
| 14 | Decide what needs approval (optional) | Stopping production, say, can wait for an approver's agreement | Only with approval on a rule. See Approvals |
| 15 | Connect Slack, Teams or a webhook (optional) | Reminders before a machine is stopped, approval requests, alerts | .env (or /etc/delegaris/delegaris.env with the Linux package) for the Slack tokens, then Settings > Notifications. See Slack and Teams and webhooks |
| 16 | Check backups and health | Everything Delegaris remembers, including tag values it has taken off, is in its database | Settings > Health and backups. See Backups and health |
| 17 | Brand it (optional) | Your organisation's name, logo and colours | Settings > Branding. See Branding |
| 18 | Tell people | So they know where to go and what they can do | See below |
Test as an ordinary user
Before telling everyone, sign in as someone who is not an administrator and check that Resources shows what their rules should give them, and nothing more. Their own rules are listed under My account.
Telling people
Send people the address and a few lines like these:
- Sign in with your usual Windows username and password (or Sign in with Microsoft).
- Resources lists the machines you can use. Click one to start it, stop it, or keep it on past its schedule.
- If you cannot see something you need, press Request access and say what and why.
- My account (click your name, top right) shows what you can do and lets you turn on two-step sign-in.
Point them at The Resources page, Keeping on and Requesting access.
Afterwards
- Once a directory sign-in works and an administrator from it can sign in, keep the local administrator as the break-glass account, with its password kept safe and two-step sign-in on (remove it only if you do not want a break-glass account). See Local administrator.
- Watch Approvals for requests for access in the first days.
- Check Activity and Reports to see how Delegaris is being used.
Next steps
- Navigating Delegaris: where everything is
- How sign-in works
- Access rules