Skip to content

Administration

This page is for Admins. As well as everything a Songwriter sees in the admin panel, Admins see Users under Dashboard, Logs in the Content group, and a Site group with Themes, Settings, Email templates and Audit. For the rest of the admin panel, see Writing songs.

Anything that’s hard to undo asks you to confirm first. Selecting the button opens a confirmation with Cancel and the action’s own button; Cancel is selected to start with, so pressing Enter does nothing by accident.

Admins see more on the dashboard than Songwriters do, in this order:

  • To do: how many people are waiting for approval, how many sign-ups haven’t confirmed their address yet, and how many corrections are waiting. Each links to the right list. When there’s nothing, it says Nothing waiting.
  • Email: whether the site’s email is Off, Working, Failing, or on with nothing sent yet. If it’s off, it says why, with a link to Settings. It also counts what was sent in the last 7 days by kind of email, and describes the last email that failed or was refused, with the reason.
  • Scheduler: whether housekeeping is Working, Late, Failing or Not run yet, and when it last ran. See Housekeeping.
  • Media: how much the media library holds, with a link to it.
  • Counts of Songs, Categories, Active members and Setlists.
  • Latest in the audit log: the 10 newest entries, with a link to The whole audit log.
  • At the bottom, the version of Songbook that’s running and when it was deployed.

Every 15 minutes, Songbook tidies up by itself. It clears expired sessions and links, finished rate limits, email log entries older than 90 days, and old notifications (read ones after 60 days, any after 180). It also removes sign-ups that were never confirmed, seven days after their newest link, freeing their usernames, and drops changes of email address whose link has run out.

The Scheduler card shows how it’s going. Late means it hasn’t run for more than three times its interval; Failing names each step that went wrong. Run housekeeping now runs it straight away and says how it went.

Users lists every account, 25 to a page. Use the buttons at the top to see only Pending, Active or Suspended accounts, or All. The search box, Search name, username or email…, searches within the list you’re looking at.

Each account shows its name and username, Email, Role, Status, how many Setlists it has, when it Joined and when it was Last seen. Accounts waiting for approval are listed first, those that have confirmed their address before those that haven’t. An address that hasn’t been confirmed yet is marked not confirmed.

The number beside Users in the sidebar counts the people waiting for approval who have confirmed their address.

There are no actions in the list. Select a name to open that person’s page.

A person’s page shows:

  • Account: their username, email (and whether and when it was confirmed), role, status (with the reason, if suspended), when they joined, when they were last seen, and how many devices they’re signed in on.
  • In the songbook: how many favourites, setlists and corrections they have and how many songs they’ve added, with Content activity, which lists what they’ve done with songs, setlists and corrections.
  • Manage: everything you can do to their account. What’s there depends on their status.
  • Audit log: the latest account events about them, both what they did and what was done to them, with a link to all of them.

Your own page has no actions. Change your own account from Settings, like everybody else.

After each action, a message at the top of the page says what happened, including whether the person was emailed. If they weren’t, because the site isn’t sending email or their address isn’t confirmed, it tells you to let them know yourself.

A pending account is waiting for you. If the site is sending email, it has to confirm its address first: until then, the page says Approve appears once they’ve confirmed. When the site isn’t sending email, there’s nothing to confirm, and you can approve straight away.

  • Approve lets the person log in. They get an email saying their account is approved, and a notification.
  • Decline… asks you to confirm, then emails them that their registration wasn’t approved and deletes the sign-up.

Whether new accounts need approving at all is up to you: see Registration.

On an active account, Suspend… asks for a Reason for suspending of 5 to 500 characters. They see the reason when they try to log in, and in an email. Suspending them logs them out everywhere straight away.

On a suspended account, Lift suspension lets them log in again. They get an email and a notification, Your account is active again.

On an active account, select Change role…, choose Singer, Songwriter or Admin, and select Change role. The change takes effect straight away, and they get a notification and an email saying what their new role is. See Roles for what each role can do.

On an active account, Reset password… sends them a link to choose a new password. It works for one hour, and their current password keeps working until they use it. You never choose or see their password.

If the site isn’t sending email, or their address isn’t confirmed, you’re shown the link instead, to pass on yourself. It’s shown only once: leave the page and it’s gone, though you can always issue another.

Select New account at the top of Users. Enter a Username, an optional Display name, their Email and their Role, and select Create account.

The account is active straight away. You never choose its password: the person gets an email with a link to choose their own, which works for 24 hours. If the site isn’t sending email, you’re shown the link to pass on yourself, once.

On an active or suspended account, select Delete account…. The delete page shows what goes (their favourites, setlists, picture, preferences, notifications and sessions) and what stays (their corrections and any songs they added, shown as from “A deleted account”). Type their username to confirm, and select Delete account. They’re emailed just before the account goes. It can’t be undone.

Keep the username reserved starts ticked, so nobody else can register that username. Untick it to free the name.

A pending sign-up is declined, not deleted.

A site always keeps at least one active admin. You can’t suspend, demote or delete the only one: you see This is the only admin, so this would leave nobody who can approve an account or change a setting. Make somebody else an admin first. You can’t act on your own account from Users at all.

A theme sets the colours, fonts and corner rounding of the whole site, including the song sheets and chord diagrams, in both light and dark mode. Songbook comes with two built-in themes, Paper (warm, like a printed songbook) and Slate (cool and modern). You can edit those and make your own.

The theme you make the default is the one visitors see, and anyone who hasn’t chosen their own. Everyone can pick a different one under Display on any song; see Display options.

Themes shows a card for each theme, with a few of its colours and whether it’s built-in or custom. The site’s current theme is marked default. On each card:

  • Edit opens the theme editor.
  • Make default makes it the site’s default theme.

To make a new theme, select New theme, give it a name and select Create. It starts as a copy of the current default theme.

The theme editor has a table of colours, grouped into Page, Text, Buttons, Song sheet and Diagrams, with a Light and a Dark column for each. Select a colour’s swatch to open the colour picker, or type a colour as a hex code such as #8a4b1f.

Group Colours
Page bg the page background, panel cards and panels, panel-border their edges, hairline thin dividing lines
Text text body text, heading headings, subtle quieter text, link links, accent highlights
Buttons btn-bg and btn-text, a button’s colour and its label
Song sheet chord chord names, chorus-bg and chorus-border the chorus block, tab-bg behind tabs
Diagrams diagram-fret strings and frets, diagram-dot finger dots, diagram-dot-text the numbers in them, diagram-text chord names and markers

Under Typography & shape are four settings used in both modes: Corner radius (a number with px, rem or em, such as 6px), and Body font, Heading font and Monospace font, each a list of font names separated by commas.

The Preview beside the table shows a short piece of a song, with chords, a chorus, a tab and a diagram, in your colours as you change them. Switch it between Light and Dark to check both.

Select Save theme to keep your changes. They reach the site within about a minute. Songbook checks the theme first, and saves nothing if:

  • a value doesn’t fit: a colour that isn’t a hex code, a radius without a unit, or a font list with anything but font names
  • the body text (text) is too hard to read against the page, panels, choruses or tabs: it needs a contrast of at least 7:1 on each, in both light and dark mode

The editor says what’s wrong, marks the values, and keeps everything you typed so you can fix it.

Also on the editor:

  • Make default, if it isn’t the default already.
  • Reset to default… (built-in themes): asks you to confirm, then puts the theme back the way Songbook ships it, throwing away your changes.
  • Name and Delete theme… (your own themes): built-in themes can’t be renamed or deleted. If you delete the default theme, Paper becomes the default.
  • Duplicate this theme: type a name for the copy and select Duplicate. The copy opens, ready to edit.

Settings holds the settings for the whole site. Select Save settings when you’ve made your changes. Songbook checks every field before saving anything: if one needs fixing, nothing is saved, the page keeps everything you typed, and the message sits beside the field.

  • Site name (required, up to 60 characters): shown at the top left of every page, as the heading of the song list, in the footer, in the browser tab’s title and in the emails Songbook sends.
  • Tagline: a short line shown under the heading of the song list and in the footer, after the site’s name.
  • Site URL: the site’s public address, such as https://songs.example.com, with nothing after it: no path and no slash at the end. Every link in an email starts with it, so email can’t be switched on without it.
  • Email From address: the address every email is sent from, such as songbook@example.com or Songbook <songbook@example.com>. It has to be verified under Cloudflare Email Routing for its domain. Email can’t be switched on without it.
  • SEO title template: how the browser tab’s title is made up on every page. Write %s where the page’s own title goes: with %s | My Uke Club, a song’s tab reads “Down by the Harbour | My Uke Club”. Leave it blank and titles read like “Down by the Harbour — Songbook”, using the Site name.
  • Default SEO description: a sentence or two, up to 200 characters, describing the site, which search engines and link previews can show.

Send email switches all of Songbook’s email on or off. It needs a valid Email From address and a Site URL; without them, saving says what’s missing.

Switching email off also moves anyone still waiting on a confirmation link straight into the approval queue, and cancels any change of email address waiting on its link. The hint under Send email says how many people that affects before you save.

When email is on, a Test email box under the settings has Send a test email, which sends a short test to your own address and says what happened.

Only confirmed addresses get email, except where reaching an unconfirmed one is the point, such as a confirmation link. Every email ends with a footer saying why it was sent and that replies aren’t read.

Choose how people can join:

  • Closed: nobody can register. The register page says so, and the menus don’t offer it.
  • Approval: people register (and, with email on, confirm their address), then wait for you to approve them under Users.
  • Open: with email on, people register, confirm their address, and are logged in straight away. With email off, this works exactly like Approval.

The description under each choice changes to match whether email is on.

More reserved usernames: words nobody can register as a username, separated by spaces or commas. The hint lists the ones that are always reserved, such as admin and the names of the site’s own pages.

This lets people use their Songbook account to sign in to Forge, the Dragon’s Lair ticket tracker. Forge sees a person’s name and email address once they’ve said yes, and nothing else. What people see is described in Signing in to Forge.

  • Tick Sign in to Forge to switch it on.
  • Enter Forge’s address, such as https://forge.example.com: just the address, with nothing after it. Forge may only send people back to that address.

Switching it off stops it at once: Forge’s requests get Page not found, and sign-ins already under way stop working.

  • Default theme: the same as Make default on the Themes page.
  • Enable the “Suggest a correction” form: when this is off, Suggest a correction disappears from every song.

Every setting you change is recorded in the audit log, with its old and new value.

Every email Songbook sends has a template you can change. Select Email templates in the sidebar.

The list shows each template, its Subject, and whether it’s using the Default or has been Customised:

Template Sent when
Verify email address Someone registers, or asks to confirm their address from Settings. It has the link to confirm it.
Password reset Someone asks to reset their password, or you reset it for them.
Account approved You approve an account.
Sign-up declined You decline a sign-up, just before it’s deleted.
Account created by an admin You create an account. It has the link to choose a password.
Password changed Someone changes their password in Settings or with a reset link.
Confirm a new email address Someone changes their email address. Sent to the new address.
Email address changed A change of email address is confirmed. Sent to the old address.
Account suspended You suspend an account. It includes your reason.
Suspension lifted You lift a suspension.
Role changed You change someone’s role.
Account deleted by an admin Just before you delete an account.
Admin — new registration Someone confirms their email and is waiting for approval. Sent to Admins who have Email me when somebody is waiting for approval ticked.
New correction submitted Someone suggests a correction. Sent to Songwriters and Admins who have Email me when a correction is suggested ticked.
Correction resolved A songwriter accepts or rejects a correction. Sent to the person who suggested it.

Select a template to edit its Subject and Body (HTML). Under the body is a list of placeholders, such as {{name}} and {{link}}, that are filled in when the email is sent. Select Save template to save it. Reset to default puts back Songbook’s own wording.

You don’t need to add a footer: Songbook adds one to every email, saying why it came and that replies aren’t read. The two admin notices also get a link to stop them.

Audit opens the Audit log: every account event and settings change, newest first, 30 to a page. Each entry shows When, Who did it, What they did, and the Account it was done to.

It records approvals, declines, suspensions and lifted suspensions, role changes, password resets you issued, accounts you created or deleted, people changing their own password or email address, setting a password from a link, deleting their own account, letting Forge sign them in or disconnecting it, every change to a site setting, and sign-ups removed by housekeeping. It never records anyone’s email address or password.

Choose from Action and select Go to see one kind of event. Select a name to see only the entries about that person.

Logs opens the Activity log: what people have done with the site’s content, newest first, 40 to a page. Each entry shows When, Who, the Action, what kind of thing it was done to, and any Detail, such as a song’s title.

It records logins, registrations and email confirmations, password reset requests, songs, categories and media being added, changed or deleted, corrections being sent and resolved, setlists being created, changed and deleted, and changes to themes and email templates. Account events and settings changes are in the audit log instead.

Choose a person from All users to see only what they’ve done.