Skip to content

Finding Your Way Around Settings ​

Settings is one page with a list of areas down the left. The areas come in two groups: You, which everyone has, and Server, which only admins see. If you know what a setting does but not where it lives, search for it - see Finding a setting.


You ​

Your own account and how Grimoire looks and behaves for you. Nothing here changes anything for anyone else.

AreaWhat's in it
AccountProfile (display name, email), Password & sessions (change password, active sessions), and deleting your account
PreferencesLanguage & theme, and Reading & browsing (the reader, how the library lists things, content preferences)
ConnectionsYour OPDS feed for e-reader apps, your API keys, and the share links you have made

API keys and share links only show up when you are allowed to make them.

Server (admins) ​

How the whole server behaves. Admins land on Overview when they open Settings; everyone else lands on Account.

AreaWhat's in it
OverviewOne line each on scanning, backups, sign-in, people, add-ons and Grimoire Codex DB, with a link to the settings behind it
PeopleUsers - roles, permissions, passwords, library access grants - and the guests GMs have invited
Access & sharingShare links by role, category restrictions, campaign upload limits, and every user's API keys
Sign-inPassword sign-in, single sign-on (OpenID Connect), guest invite codes, and the login page message
LibraryScanning (rescan, watch for changes, scheduled rescan), Files & folders (folder category inference, folder naming patterns, variant filename rules), Library tools (the file manager, duplicate detection), and Database Cleanup in the danger zone
MetadataGrimoire Codex DB, the lists the metadata editors offer (genres, system families, parent systems, licenses, dice materials), and sidecar files
Add-onsCommunity add-ons and the character content packs installed from them
SidebarWhich sections and stats the sidebar shows to everyone
BackupsBackups taken by hand or on a schedule
LogsWhat the server has been doing, live, filtered by level, user or text

Rescan and File manager buttons sit at the top of every Server page, so neither is more than a click away.

Where the old tabs went ​

Settings used to be a row of tabs. Their contents moved like this:

Old tabNow in
AccountAccount, Preferences and Connections
UsersPeople; the share links role switches moved to Access & sharing
AuthenticationSign-in
ApplicationSidebar, Access & sharing, and Library → Files & folders (folder category inference)
MetadataMetadata; folder naming patterns and variant filename rules moved to Library → Files & folders
Add-onsAdd-ons; Grimoire Codex DB moved to Metadata
MaintenanceLibrary, Metadata → Sidecar files, and Backups
LogsLogs

Old links such as /settings/maintenance still work and open the area that took over.


Finding a setting ​

The search box above the list of areas finds any setting by its name or by the words people usually use for it - "sso" finds single sign-on, "dark mode" finds the theme. Press / or Ctrl+K (⌘K on a Mac) to jump to it from anywhere in Settings, use the arrow keys to pick a result, and Enter to go there. Grimoire opens the right area, expands the group the setting is in, scrolls to it and highlights it briefly.

Search only offers what you can use: someone who isn't an admin never sees Server settings in the results.

Linking to a setting ​

Every setting has its own address, /settings/<area>#<setting> - for example /settings/library#cleanup for Database Cleanup or /settings/connections#opds for your OPDS feed. Once you have gone to a setting, copy the address from the browser to send someone straight to it. Opening the link scrolls to the setting and expands its group, the same as a search result. A link to a Server setting opens your own Account page instead for someone who isn't an admin.

Unsaved changes ​

Most settings save as soon as you change them; a few have a Save button. If you try to leave a page with changes you haven't saved, Settings asks before discarding them.

Released under the GNU GPL v3.0 License.