Administration
This page is for the person who runs a DragonNotes site. Admins get an Admin button (a spanner) in the top bar, or under Account on a phone. It opens six sections: Dashboard, Users, Site pages, Themes, Settings and Audit. When sign-ups are waiting for you, Users shows how many.
The admin area is for the site, not for notes. Nothing in it shows the contents or titles of anyone’s notes, and being an admin doesn’t let you read other people’s private notes or edit anything of theirs.
Setting up a new site
Section titled “Setting up a new site”Until a new site has been set up, every page sends you to /setup.
- Give The site’s name. It’s used everywhere the site names itself: page titles, emails and the installed app’s label. You can change it later in Settings.
- Choose a Username, and enter your Email and a Password of at least 12 characters.
- Select Create account.
That account is the admin, and you’re logged in straight away (Account created. Welcome.). The setup page only ever works once: after that it’s gone for good, even if every account is later deleted.
Open the setup page at the site’s real address. That address becomes the site’s Address in Settings, which every link in an email is built from.
A new site starts with public notes on, registration Closed and email off. Go through Settings before inviting anyone.
Dashboard
Section titled “Dashboard”The dashboard starts with what needs doing:
- Waiting for you: sign-ups waiting for approval, each linking to their own page. A sign-up whose address isn’t confirmed yet is marked address not confirmed, and can’t be approved until they follow their link.
- Email: whether mail is off, working or failing (or nothing sent yet), what has gone in the last week by kind, and the last message that was refused or failed, with why.
- Scheduler: when the housekeeping job last ran, and whether it’s working, late, failing or never run. Every fifteen minutes it clears expired sessions and links, old rate limits and mail records, and import previews nobody finished; once a day it also deletes stored files that nothing refers to any more. Run housekeeping now runs it straight away.
Then come the numbers: space Stored, Files, the storage limit for Each user and how many people are Near their limit, then Accounts, Notes, Public notes, Tags, Links and sessions Signed in.
Lately lists the newest entries from the audit log, with The whole log. At the foot is the version that’s running and its newest database migration.
The Users list shows everyone, with sign-ups waiting for you first. Search by name, username or address, choose Everyone, Waiting, Active or Suspended, and select Show. Each row shows the person’s status (active, waiting or suspended), admin if they are one, their note count, when they joined and when they were last seen. On a site that sends email, an address that hasn’t been confirmed is marked address not confirmed.
The list has no buttons of its own: select a person to open their page, where every action lives.
A person’s page
Section titled “A person’s page”Each person’s page, at /admin/users/<number>, shows their address (and whether it’s confirmed), when they joined and were last seen, their role and status (with the reason, if they’re suspended), how many devices they’re signed in on, counts of what’s in their notebook (never titles), and their storage. What has happened lists their entries in the audit log.
Under What you can do are the actions that make sense for them now:
- Approve: lets a waiting account sign in. It’s only offered once they’ve confirmed their address (or straight away when email is off). A sign-up that never confirms is removed after a week.
- Decline: removes a waiting sign-up, and frees the address. You confirm with Decline and remove.
- Suspend: signs them out everywhere, stops them signing in, and stops their public notes showing. Give a reason of 5 to 500 characters under Why (they will see this): they’re shown it when they next try to sign in with the right password, and it’s emailed to them. Lift the suspension undoes it.
- Make them an admin or Make them a user, confirmed with Change it.
- Reset their password: makes a link for them to choose a new password, confirmed with Make the link. It goes to their address. If no email can go (email is off, their address isn’t confirmed, or the send failed), the link is shown to you once, on the page, to pass on yourself. It works once, for an hour. Nothing changes until they use it, and then every device they’re signed in on is signed out. You never choose, type or see their password.
- Delete: see Deleting an account.
Each change that affects them is emailed to them, and the message on the page says whether that email went. If it didn’t (email is off, their address isn’t confirmed, or the send failed), it tells you to let them know yourself.
Your own page says This is you. The admin pages never act on your own account: change it in your settings, like everyone else. The site’s only active admin can’t be demoted, suspended or deleted: make someone else an admin first.
Storage limits
Section titled “Storage limits”Every upload counts towards its owner’s storage: pictures, attachments and their profile picture together. The default limits are in Settings under Storage. To give one person a different limit, set Limit in MB under Their storage on their page and select Save their limit. Leave it empty for the default for their role, or enter 0 for no limit. A limit only stops new uploads: nothing already stored is deleted.
Creating an account by hand
Section titled “Creating an account by hand”Open Create an account by hand, enter a Username and Email, and optionally turn on Make them an administrator. Select Create account.
The account is active and its address counted as confirmed straight away, since you’re vouching for it. Nobody chooses a password for it, you included: they get a link to choose their own, which works for a day. It’s emailed to them (The account is made, and a link to choose a password is on its way to them.), or, if no email can go, shown to you once to pass on.
Deleting an account
Section titled “Deleting an account”Select Delete on their page. The confirmation lists what will go: every note (including private ones) and every revision of them, every file, and every tag, template, link and redirect. If the site sends email, they’re told before it goes.
Keep … reserved is on, so nobody else can take the name and have old links land on their notes. Turn it off to free the name. Type their username under Type … to confirm and select Delete the account.
Retired usernames
Section titled “Retired usernames”Retired usernames lists names that are held so nobody can register them: every name someone has changed away from (so their old links keep redirecting to them), and names kept when an account was deleted. Release puts a name back in the pool, after you confirm with Release it.
Audit is the site’s log of who did what: approvals, suspensions, role changes, deletions, password resets and storage changes by admins; password, address and username changes, self-deletions and Forge sign-in permissions by people on their own accounts; changed site settings; and sign-ups the housekeeping job removed. It records names, never addresses, and nothing is ever deleted from it.
Choose an action from the list and select Show to see only that kind. Select a name to see only what involves that person. Newer and Older page through it.
Site pages
Section titled “Site pages”Site pages are the site’s own information pages, such as /about or /privacy. The list shows each page’s state (published or draft), length, and when and by whom it was last edited.
To make one, under New page, give it a Title and a Slug, and select Create and edit. New pages start as drafts.
The slug has to be a reserved word, because site pages share the top level of the site with people’s notebooks. Plenty are reserved already, including about, help, privacy, terms, contact and support; the full list is under Reserved words. If you want another, add it to the reserved words first.
Pages use the same editor as notes, including images. Turn on Published — anyone can read it at /… and select Save to publish it. A draft is visible to admins only, with a banner saying so. View opens the page. Delete page removes it: type the page’s address to confirm, then select Delete the page.
An About link appears in the top bar once there’s a published page at /about. While it’s a draft, only admins see the link. The front page for people who aren’t logged in is part of the app and can’t be edited.
Themes
Section titled “Themes”Every theme is listed as a card with its light and dark colours, its key, how many people use it, and whether it’s the default or not offered. Each card has Edit and Duplicate.
The three built-ins, Volt, Ember and Neon, ship with the app. They’re always offered and can’t be deleted, but you can change their colours; an edited built-in is marked edited, and Revert to shipped puts its original colours back. Duplicate makes a separate copy of any theme that you can change freely.
Editing a theme
Section titled “Editing a theme”The editor has the theme’s Name, Description and (for themes you’ve made) Key, which is the name in the theme’s stylesheet address. Changing a key keeps everyone using the theme on it.
Below that, every colour has a light value and a dark value, grouped into Surfaces, Text, Primary, Accent and Lines and shadow. Type a hex colour or use the swatch to open a colour picker. The Live preview shows both modes as you go.
When you change color-primary or color-accent, the text colour that sits on it changes too, to whichever of the theme’s own text and background colours reads better. If you set that text colour yourself, it’s left alone.
Contrast is checked as you type, in both modes. Every text pair (body text, muted text, links, and text on buttons and highlights) has to reach 7:1; the check on borders is advice only. You can always save, but a theme with a failing pair can’t be offered to people until it passes: Saved as a draft. Some pairs fall short, so it is not offered to people yet. Show every pair, both modes lists every check.
Under Availability:
- Offer this theme to people (themes you’ve made only): whether people can choose it in their settings.
- Make it the site default: the theme for people who aren’t logged in and for new accounts.
Select Save theme. Revert to source puts a duplicate’s colours back to the theme it was copied from. Delete theme removes one you’ve made, after you confirm; anyone using it moves to the site default. The site default itself can’t be deleted.
Settings
Section titled “Settings”Under Site:
- Name: the site’s name, shown in every page title, the top bar, the emails the site sends and the installed app’s label.
- Tagline (optional): the line in the footer, after the name. Leave it empty and the footer shows the name alone.
- Address: the site’s own web address, such as
https://notes.example.com. Every link in an email, and the public link on each person’s home base, is built from it, rather than from whatever address a page happened to be opened on. It’s filled in at setup, and has to starthttps://.
Under Visibility, Public notes work is the master switch. Turn it off and nothing is readable without logging in, whatever individual notes say. Useful if something is published by accident. There’s deliberately no setting to let search engines index the site.
Under Registration, How new accounts get in:
- Closed: nobody can create an account.
/registersays so. - Approval: a new account confirms its address by a link first (when email is on), then waits for an admin to approve it.
- Open: a new account confirms its address by a link, and following it signs them in. With email off, Open works as Approval, so nobody gets in on an address nobody has proved.
Under Email:
- From address: who the site’s emails come from, either a bare address or
Name <address>. It has to be added as a custom address in Cloudflare Email Routing, or nothing will send. - Email is configured: turn this on only once the From address is set up in Cloudflare Email Routing. You can’t turn it on without a From address. With it off, new accounts are approved by hand, password reset says it’s unavailable (you can make a reset link instead), and people change their email address without a confirmation step.
Switching email off while people are waiting on links moves any sign-ups still waiting to confirm into the approval queue, and cancels any waiting changes of address. The page says beforehand how many that affects. Switching it on locks nobody out: accounts made while it was off keep signing in, and are asked to confirm their address from their settings.
Under Sign in to Forge:
- Sign in to Forge: lets people with an account here use it to sign in to Forge. Forge sees their name and email address, once they’ve said yes, and nothing else. Each person can disconnect it from their own settings. Turn it off and Forge’s requests are refused, and any sign-in already in progress stops working.
- Forge’s address: Forge’s own web address, such as
https://forge.example.com, with nothing after it. Forge can only send people back to that address.
Forge has its own setting to offer DragonNotes on its sign-in page. Both have to be switched on.
Under Default theme, choose what logged-out visitors and new accounts get. Someone reading a public notebook sees its owner’s theme instead.
Under Storage, set how much each person may upload, in MB, For a user and For an admin. 0 means no limit. A new site allows 500 MB for a user and no limit for an admin. One person’s own limit, set on their page, wins over these.
Reserved words
Section titled “Reserved words”A reserved word is one nobody can register as a username, which is what makes it free for a site page. Add your own under Words you have added, one per line or separated by commas.
The page lists the words site pages are using, and warns you about any word you’ve added that’s already somebody’s username: reserving it doesn’t take it back, and a page can’t use it. The … words reserved by the app itself lists the built-in ones.
Select Save settings. Everything is checked before anything is saved. If something can’t be used, nothing is saved, and each problem is marked beside its field. If nothing had changed, it says Nothing had changed, so nothing was saved.
Site images
Section titled “Site images”Under Site images you can replace the Favicon, Wordmark (the mark beside the site name in the top bar), App icon (for installed copies on a home screen) and Share image (the picture shown when someone pastes a link to the site into a chat). Each has its own Upload button, and is used everywhere as soon as it’s saved.
Each can be up to 512 KB. The marks can be SVG (as long as it has no script in it) or PNG; the share image has to be PNG, JPEG or WebP, ideally 1200×630. Camera details are taken off. Go back to the built-in (or Remove it, for the share image) undoes an upload.
Testing the mail
Section titled “Testing the mail”Under Test the mail, Send a test sends one message to your own address and says whether it went. The Email card on the dashboard keeps the record.
Emails the site sends
Section titled “Emails the site sends”When Email is configured is on, DragonNotes sends these from the From address, with the site’s Name in the subject:
- a link to confirm a new account’s address
- password reset links, and the link an account made by hand gets to choose its first password
- a note to the account holder when their password is changed
- a link to confirm a new address when someone changes their email, and a note to their old address once it’s changed
- a note to someone when an admin approves, declines, suspends, or deletes their account, lifts a suspension, or changes their role
- a note to every admin when someone registers and has confirmed their address, unless they’ve turned off Email me when somebody registers in their own settings
- the test message
Every message, sent or not, is recorded for the Email card. Mail is never sent to an address nobody has confirmed, except a link whose job is to confirm it, nor to an account that’s suspended or gone.
