User manual

Getting started

After registering or receiving login credentials, sign in using the method configured by your administrator:

• Email code: Enter your email address and you'll receive a 6-digit verification code. Enter it on the next screen to log in. The code expires after 10 minutes.
• Password: Enter your email and password.
• Password + 2FA: Enter your email and password, then enter the 6-digit code sent to your email.

If the system switches from email code to a password mode and you don't have a password yet, you'll be prompted to set one using a verification code.

Once logged in, you'll see the home page with any news or announcements. Use the navigation bar at the top to access different sections.

Projects

Projects are the main content type. Each project has a name, a short description, and rich text content that supports formatting, images, and links.

Creating a project

Click Add project on the projects page. Fill in the name and description, then use the rich text editor for the content. Click Create project or press Ctrl+S to save.

Editing a project

Open a project and click Edit. Changes are saved via AJAX: A save indicator appears at the top right of the page. It shows:

• Unsaved changes (red, pulsing): You have unsaved edits
• Saving... (green): Save in progress
• Saved! (green): Changes saved successfully

You can also click the indicator or press Ctrl+S to save at any time.

Copying a project

Click Copy on the projects list to duplicate a project. The copy is created with "(copy)" appended to the name and assigned to you as the creator.

Filtering projects

Use the search bar to filter by name or description. Use the date filters to narrow by creation date. Click My projects to see only your own.

Rich text editor

The editor toolbar provides formatting options grouped by function:

Text formatting

Bold, italic, underline, strikethrough, and inline code. Select text and click the corresponding toolbar button, or use keyboard shortcuts (Ctrl+B, Ctrl+I, Ctrl+U).

Headings

Six heading levels (H1 through H6). Click a heading button to toggle the current paragraph to that heading level. Click again to revert to a normal paragraph.

Alignment

Align text left, center, or right. Select the paragraph or heading and click an alignment button. Alignment is stored as an inline style on the element.

Lists and blocks

• Bullet list and ordered list
• Blockquote: Indented, styled quote block
• Code block: Monospace block for code snippets

Links

Select text and click the link button to add a URL. Click again on linked text to change or remove the link. To link an image, select the image first, then click the link button.

Images

Click the image button in the toolbar to upload an image (maximum 5 MB). Once inserted:

• Resize: Drag the handles at the corners or edges of the image
• Align: Select the image and use the alignment buttons
• Link: Select the image and click the link button

Undo and redo

Use the toolbar buttons or Ctrl+Z / Ctrl+Shift+Z.

Users

The users section lists all registered accounts. Depending on your permissions, you may be able to:

• View user profiles (name, role, creation date, last login)
• Create new users and assign them a role
• Edit user details and change their role
• Delete users (moves them to trash)

Your profile

Click your avatar in the navigation bar to view your profile, then click Edit to change your settings:

• Starting view: The page you see after logging in (default is home)
• Theme: Light or dark mode
• Password: Change your password (when using password authentication)

Admin notifications

Administrators see additional options on their profile:

• Notify on new users: Receive an email when a new user completes their first login
• Notify on new content: Per-model toggles for email alerts when new items are created (e.g., new projects, new roles)

A pulsing indicator appears on the Users nav item when new users have registered since your last visit to the users list.

Roles and permissions

Access control is managed through roles and permissions. Each user is assigned one role, and each role has a set of permissions.

Permissions

Permissions follow the pattern model.action:

• view: See the list and detail pages
• create: Add new items
• edit: Modify existing items
• delete: Remove items (to trash)

For example, projects.view allows seeing projects, and users.edit allows editing user profiles.

Default roles

• admin: All permissions, can assign any role
• user: Can create projects

Administrators can create custom roles, copy existing ones, and configure which roles each role is allowed to assign to others.

Navigation manager

Administrators can customize the main navigation menu at Settings → Navigation.

• Add items with a label and URL
• Reorder using the up/down arrows
• Nest items by clicking the indent arrow to make an item a child of the one above it
• Outdent child items to promote them back to top level
• Set visibility by checking roles (admin, user) for each item

Guest access

Check the guest role on a nav item to make it visible to users who aren't logged in. This also makes the corresponding page publicly accessible. For example, checking "guest" on the Projects item lets anyone view the projects list and individual projects without logging in.

If a child item has guest access, its parent dropdown automatically appears for guests too.

Settings

Application settings are managed at Settings (requires the settings.manage permission). Settings are organized by group:

Auth

• Authentication mode: Email code, password, or password + 2FA
• Allow registration: Enable or disable new account creation

General

• News: Rich text content displayed on the home page (a pulsing indicator on the site logo alerts users to updates they haven't seen)
• Publication year: Year for the copyright notice in the footer. Set to 0000 for the current year only, or enter a year like 2024 to show a range (e.g., "2024 - 2026")

Appearance

• Accent color: Grayscale, green, blue, amber, or rose
• Font pairing: Choose from several display/body font combinations, or use the system default

Trash

• Retention days: How long deleted items stay in trash before automatic cleanup (default 30 days)
• Auto cleanup: Enable or disable automatic removal of expired trash items

Changes are saved via AJAX. Press Ctrl+S or click the save indicator to save.

Themes and appearance

Dark and light mode

Click the sun/moon icon in the navigation bar to toggle between light and dark themes. Your preference is saved to your profile and remembered across sessions.

Accent colors

The accent color affects buttons, links, highlights, and interactive elements across the entire application. Choose from grayscale, green, blue, amber, or rose in settings.

Font pairings

Each font pairing sets a display font (used for headings, buttons, and labels) and a body font (used for paragraphs and general text). All fonts are hosted locally: No external requests are made.

Activity log

The activity log records all changes made to the application. Each entry shows:

• What was changed (model type and name)
• What action was taken (created, updated, deleted, restored)
• Who made the change
• When it happened

Click View on a log entry to see the full details, including the exact field changes with old and new values.

Use the filters to narrow the log by model type, action, user, date range, or search term.

Trash

When you delete an item, it moves to the trash instead of being permanently removed. From the trash, you can:

• Restore: Put the item back where it was, including its relationships (e.g., a user's role assignments)
• Delete permanently: Remove the item forever
• Empty trash: Permanently delete all items in the trash

Items are automatically removed from trash after the configured retention period (default 30 days) if auto-cleanup is enabled.

Keyboard shortcuts

On macOS, use Cmd instead of Ctrl.