Skip to content

Docs Self-hosting

Accounts and registration

Create the owner, choose who can sign up, invite people and deactivate users.

Roles

Role Who What the role can do
Owner The person who runs the instance. The is_owner flag marks this user. Everything that an admin can do. Also opens /admin and /horizon.
admin A member of a company. Creates and changes templates, snaps, forms, tokens and invitations.
customer A member of a company. Creates content, the same as admin.

Each user belongs to one company. Templates, snaps, forms and tokens belong to the company of the user.

Create the owner

The first account of an instance is the owner. Create it in one of two ways:

  • The setup page. Open /setup?token=<token>. Run php artisan snapsbrew:setup-url to show the full URL. The Docker web container also prints it to its log.
  • The command line. Run php artisan snapsbrew:install. The command asks for the name, the email and the password. You can also give --name, --email, --password and --company.

The setup page is open only while the users table is empty. While no user exists, /, /login and /register send the visitor to /setup. After the first account exists, /setup returns 404.

The setup token comes from APP_KEY through HMAC-SHA256. The instance stores no token. The setup routes accept 10 requests a minute.

php artisan snapsbrew:install creates no second owner. If an owner exists, it shows the email of the owner and stops.

Make another user the owner

To make an existing user the owner, run:

Terminal

php artisan snapsbrew:install --promote=person@example.com

With Docker, add docker compose exec web before the command. The command sets the owner flag and creates no account.

Registration modes

Mode Who can sign up Company of the new account
Invite only Only a person with a pending company invitation. The company of the invitation.
Open Anyone. A new company for each account.

In both modes, an invitation works.

The mode comes from two places:

  1. The value that the owner sets in Admin > Settings (/admin/settings). The app stores it in the instance_settings table.
  2. REGISTRATION_ENABLED, when the owner has set no value. false is invite only and true is open. The default is false.

The value in Admin > Settings wins over REGISTRATION_ENABLED.

Invite people

  1. Open Account > Users.
  2. Type the email of the person.
  3. Send the invitation.

The app sends an email with a link to /register?invitation=<token>. The invitation expires after 7 days. The app refuses a second invitation while the first one is pending. It also refuses an email that is already a member of the company.

The invitation email needs a working mailer. If MAIL_MAILER is log, the email and its link go to the log. Read Configuration.

New users also see an onboarding page. It can send up to 25 invitations at one time.

The admin area

Only the owner can open /admin. Every other visitor, a guest included, gets a 404.

Page What it does
Admin > Users (/admin/users) Lists every account of the instance, with a search by name or email. Deactivates and reactivates users.
Admin > Settings (/admin/settings) Sets the registration mode.

Deactivate a user

The owner can deactivate a user in Admin > Users. A deactivated user keeps all data, but cannot authenticate:

  • The login form refuses the user and shows the reason.
  • An open web session ends at the next request.
  • The API tokens of the user stop working.
  • The OAuth tokens of the MCP server stop working.
  • The signed URLs of the user show the placeholder image.
  • The embedded forms of the user return 404.

To restore access, click Reactivate. The tokens, the signed URLs and the forms of the user work again.

The owner cannot deactivate an owner. The request returns 403.

Two-factor authentication

Each user can turn on two-factor authentication (TOTP) in Account > Security. The login and the two-factor challenge each accept 5 attempts a minute.

If a user loses the two-factor device, the owner can turn it off from the command line. Read Recover access.

Passwords

The password rules are the Laravel defaults: at least 8 characters. The setup page, the registration form, the password reset and php artisan snapsbrew:user:password use the same rules.

Edit this page on GitHub