Configure
User sign-up
Sign-up lets people create a FileRun account themselves, from the sign-in page, without an administrator creating it for them. It is off in a new installation.
The settings are in the control panel under Users → Settings → Sign up, which only the superuser can open.
Turning it on
- Open Users → Settings → Sign up and tick
Enable sign up. - Choose a
Role. The role decides what the new accounts can do and where their files are kept. FileRun refuses to save the page without one. - Save.
The sign-in page then shows a Create account button.
The button stays hidden, even with the option on, when:
- an authentication plugin is in use and
Allow local user accounts to log inis off, under Security → Authentication. The accounts then come from the external system; or - the installation already has as many user accounts as its licence allows.
What the visitor fills in
The form asks for E-mail address, Name (first and last), Phone, Company, Website address
and Comment. All of them are always shown.
The e-mail address and the first name are always required. The fieldset Required fields makes
any of the others required as well: Last name, Phone, Company, Website address and
Comment.
There is no username and no password on the form:
- The username is the e-mail address, in lower case.
- FileRun generates a password of at least 15 characters and sends it by e-mail. The user has to change it the first time they sign in.
An e-mail address that already belongs to an account is refused, and the visitor is told to use the password recovery instead.
What the new account gets
- The role chosen under
Role, with its permissions. - A home folder, built from the home folder path of that role. FileRun creates the folder if it does not exist.
- The groups listed under
Default groups.
The account's E-mail notifications option is off. Users can turn it on themselves, under
Account settings.
Give each account its own home folder
Put a placeholder in the home folder path of the role, so that each account gets a folder of its own. For example:
1/user-files/{USERNAME}
The placeholders are {USERNAME}, {EMAIL}, {NAME} (the first and the last name), {COMPANY}
and {DESCRIPTION} (the comment).
Warning
Without a placeholder, every account created through sign-up gets the same home folder, and their users see each other's files.
Default groups
The new accounts are added to the groups listed under Default groups.
The same list also applies to accounts that an authentication plugin creates the first time somebody signs in through it, not only to accounts created through this form.
Activating the new accounts
Every account is created inactive. What activates it depends on
New accounts require admin activation., which is on by default.
With administrator activation (the default)
The e-mail gives the user their username and password, and says that the account might still be waiting for the administrator.
To activate an account, open Users in the control panel, edit the account and tick
This user account is active in the Login panel. See
Reactivating a user.
Important
The e-mail tells the user that they will receive a confirmation once the account is activated. FileRun does not send one, so let the user know yourself.
Without administrator activation
The e-mail contains an activation link. Following it activates the account and opens the sign-in page. Anybody who can receive e-mail at the address they typed gets a working account, without anybody checking it.
Knowing that somebody signed up
The user activity log in the control panel records each sign-up. FileRun sends nobody a message about it by itself, but a notification rule can:
- Add a group to
Default groupsunder Users → Settings → Sign up, so that every new account joins it. A group made only for this purpose works. - Open E-mail → Notification rules and add a rule: choose that group under
User or group, tick the actionNew user registrationand put your address underNotify e-mail address.
The rule has to name a group. A rule on a user account applies only to that account, and the account that signs up does not exist yet when the rule is made.
The message goes out with the next run of the notification job, not at the moment of the sign-up. See Notification settings.
E-mail has to work
Sign-up depends on e-mail, because the password reaches the user only that way. If the message cannot be sent, the account is created anyway and the visitor is told to contact the administrator.
Set up e-mail before turning sign-up on. See The e-mail notification system.
Protecting the form with reCAPTCHA
Tick Enable reCAPTCHA and fill in Site key and Secret key. Google gives you both at
https://www.google.com/recaptcha/admin.
The keys must be for reCAPTCHA v2, of the "I'm not a robot" checkbox type. Keys for reCAPTCHA v3 do not work.
With reCAPTCHA on, the sign-up page loads a script from Google.
Sending people to your own sign-up page
If people register somewhere else — on your website, or in the system an authentication plugin
connects to — the Create account button can lead there instead. Fill in "Create account" URL,
in the URL customization fieldset of Security → Authentication.
That address is used only while FileRun's own sign-up is not available. With Enable sign up on,
the button leads to FileRun's form.
Sign-up creates regular accounts
Accounts created this way are regular user accounts, not guest accounts. Guests are invited by sharing files with them. See Guest accounts.