Step 1 - Configure the Email Server
The user registration system requires an SMTP server in order to send emails during the registration process (for example to validate a user's email address) as well as for the "forgot password" feature.
To configure this, add the following section to the SuperADMIN local.conf configuration file. If you installed to the default directory, this file is located in C:\ProgramData\STR\SuperADMIN\server\config\local.conf.
You will need to modify this to match the appropriate values for your SMTP server:
localhostwith the hostname of your SMTP server.
- Change the port number if necessary.
- If your SMTP server requires authentication, set the appropriate username and password and change
When you have finished making changes, restart the SuperADMIN/SuperSERVER service.
Step 2 - Configure Groups for Registered Users
The user registration system can automatically add new registered users to one or more user groups. This allows you to set some default permissions for newly registered users. To configure this:
Create a group in SuperADMIN for registered users. For example:
- Set the catalogue permissions for this group to an appropriate level for new users. You should ensure that they have access to at least one dataset otherwise they will not be able to log in to SuperWEB2.
Configure the user registration system to add new users to this group using the following command in SuperADMIN:
RegisteredUserswith the name of the group you created in the previous step.
Step 3 - Required Configuration Adjustments
Set the From Address
By default, emails will by sent from the address
firstname.lastname@example.org. You should change this to a real email address for your organisations. To do so, run the following command in SuperADMIN:
<new_email_address with the email address you want to use, enclosed in double quotes. For example:
Set the Base URL for Links
The email templates contain a number of links which allow users to verify their email address and continue the process. By default, the base URL of these links is set to
Use the following command in SuperADMIN to change this to match the URL of your deployment:
Set the User Registration API URL
The user registration process needs to communicate with SuperADMIN to complete the account creation process. To do this it sends messages to a SuperADMIN REST endpoint, so it needs to know where SuperADMIN is running.
You must run the following command in SuperADMIN to set the root URL for the SuperADMIN REST endpoint:
<url> with an address that resolves to the machine running SuperADMIN. The standard port number is
Step 4 - Optional Configuration Adjustments
The following are some optional adjustments you may wish to make. Refer to the detailed instructions for more details:
|Change the email templates||Default email templates are provided, but you will probably want to modify these to add your own branding and messaging.||Customise Email Templates - User Registration|
|Update the support email link in error message||A number of error messages relating to user registrations include a support email link. By default this is set to use a dummy email address (email@example.com). You should change all instances to an appropriate support email for your organisation.||Add your Support Contact Email to Error Messages - SuperWEB2|
|Configure rate limiting and token duration||You may wish to configure rate limiting (to limit the number of emails that can be sent to any given email address within a specified time) and the length of time that a verification email link will be valid for.||Rate Limiting and Token Duration - User Registration|
Step 5 - Enable User Registration
The user registration system is not enabled by default. To activate it, you need to change a setting in the configuration.properties file:
- Open <tomcat_home>\webapps\webapi\WEB-INF\classes\configuration.properties in a text editor.
Save your changes and restart Tomcat or the SuperWEB2 service.