Setting up a new sub-provider
Prerequisites and information
IMPORTANT: Before setting up a new subprovider, please read the generic article about subproviders: Subprovider
- You need a new public IPv4 IP address for a new subprovider.
- If the regify provider is directly connected to the internet
- Enter the public IP to the regify provider appliance
- If the regify provider is behind a firewall / NAT router / Loadbalancer
- The public IP must be configured to route to your regify provider software appliance or load-balancer (depending on your configuration).
- Internal routing IP address must be added into the provider appliance menu.
- A new DNS A-record must be made to route your new domain (like subprovider.company.com) to the new public IP address.
- If your provider appliance runs with its own MTA settings (one setting for all (sub)provider instances), you will also need a reverse DNS entry for email to make it work. Also, SPF records may be needed.
If you already have a SSL certificate for the subprovider domain, you can import the certificate after the subprovider was created. This works with individual and wildcard certificates.
If you do not yet have a SSL certificate for the domain, here is how to buy a SSL certificate for the subprovider domain:
- Whilst setting up the new subprovider in your appliance menu, a new self signed certificate is generated.
- You can display the signing request by choosing "Show Cert Request" in the appliance menu. Fill in the fields.
- Copy and use the signing request to order your certificate.
- If received, collect the certificate and all intermediate certificates in a text editor.
- Import certificate using "Import Cert & Optionally Key" from appliance menu and paste text editor content.
- Check correct certificate chain here at digicert (maybe only possible after you finished setup).
Setting up the subprovider
Please ensure that all prerequisites are fulfilled. Now follow these steps:
- Enter appliance menu and chose "Network..." -> "Add IP" to add the public IP address (if not yet done).
- Enter "Provider..." -> "Add subprovider" option.
- Choose the IP address added (internal address if behind firewall, router or load-balancer).
- Enter the server name of the new subprovider and answer all questions asked by the system.
- Select "Edit Subprovider..." in the appliance menu and chose the added subprovider from the menu.
- Import the SSL certificate using "Import Cert & Optionally key" from the appliance menu (not needed if the load balancer holds the certificates).
- If the provider system is running a cross-master replication, ensure that you also configure the other system in the same manner.
Continue set up in web administration
After setting up the system in the appliance menu (on all systems), you can continue with the setup by using the web administration
- Login to the web administration of the main(!) provider as a master admin and select "Manage subproviders". The new subprovider should appear in the list of subproviders.
- Selecting the new subprovider in the list of subproviders allows you to edit the settings in the lower area "Edit provider settings".
- Complete the settings of the new subprovider and finish it by clicking "Save changes".
Admin-Account and Customization
Once the subprovider has been successfully created, you need an administrator user for this subprovider to edit and do customization:
- New admin signs up for a regify account on the new subprovider.
- Activate from the email and note your password.
- Login to main(!) provider administration -> "Manage subproviders" (with existing main(!) provider admin account).
- Go to "Manage subproviders".
- Select the subprovider in the list to add the admin user to.
- Click on "Manage portal administration roles" in the "Common" tab below.
- Enter the new user as "Subprovider Admin" (you can user the "..." button to search the user ID).
- Log-out from administration screen.
- The new admin now can log-in to https://subprovider-domain/ADMINISTRATION
When the new admin logs into the web administration function, he / she will see some ToDo's. Please follow these ToDos to make sure that everything is set up correctly. Do not click on "Done" if all tasks are not really done.
You should try sending emails (eg notifications) from the new subprovider system. Copy the email address from https://www.mail-tester.com/ and send a regify account invitation to this address. Then go back to https://www.mail-tester.com/ and check your score. The maximum for a regify provider is 9 (because no DKIM signatures used). If it is less 9, please have a closer look on their reporting.
Delete a subprovider
In order to delete a subprovider, it must be emptied of all data. Thus, not a single user will be assigned to this subprovider anymore. The first step is usually to export/import all users to some other system or moved to another subprovider.
Finally, this leaves only admin accounts. Please follow these steps to get rid of the subprovider's admin users:
- You first have to enter the main provider administration portal in the "master" admin role and remove any admin roles for the affected subprovider except the one for the last and final administrator of the subprovider.
- Now, log-in with this last admin user name to the subprovider administration screen.
- Enter "Manage user" and do a simple search. Only the single admin should come up now (you). You cannot delete this account, because it is still an admin!
- Select "Action" - "Change the user data"
- On the bottom of the dialogue box, please switch the "Subprovider" to the main provider domain and click on "Save changes".
- Now, please close the window, go back to main page and log out.
- Now, you have to enter the main provider administration portal in the "master" admin role and finally remove the admin role for the affected subprovider. The "Master" role of the main provider admin stays here and does not get deleted.
Finally, the subprovider can be deleted by the SSH appliance menu.