Difference between revisions of "Setting up a new sub-provider"

From regify WIKI
Jump to navigation Jump to search
Line 1: Line 1:
 
== Prerequisites and information ==
 
== Prerequisites and information ==
  
'''IMPORTANT:''' Before setting up a new sub-provider, please read the generic article about sub-providers: [[Subprovider]]
+
'''IMPORTANT:''' Before setting up a new subprovider, please read the generic article about subproviders: [[Subprovider]]
  
 
=== Network ===
 
=== Network ===
# You need a new public IPv4 IP address for a sub-provider.
+
# You need a new public IPv4 IP address for a subprovider.
 
# If the regify provider is directly connected to the internet
 
# If the regify provider is directly connected to the internet
 
#* Enter the public IP to the regify provider appliance
 
#* Enter the public IP to the regify provider appliance
 
# If the regify provider is behind a firewall / NAT router / Loadbalancer
 
# 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).
 
#* 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 get added in provider appliance menu.
+
#* 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 sub-provider.company.com) to the new public IP address.
+
# 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 own MTA settings (one setting for all (sub)provider instances), you also need a reverse DNS entry for email to make it work. Also, SPF records may be needed.
+
# 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.
  
 
=== Certificate ===
 
=== Certificate ===
How to buy a SSL certificate for the needed sub-provider domain:
+
How to buy a SSL certificate for the subprovider domain:
# While setting up the new sub-provider in your appliance menu, a new certificate is generated.
+
# Whilst setting up the new subprovider in your appliance menu, a new certificate is generated.
# You can display the signing request by choosing "Show Cert Request" in appliance menu. Fill in the fields.
+
# 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.
 
# Copy and use the signing request to order your certificate.
 
# If received, collect the certificate and all intermediate certificates in a text editor.
 
# If received, collect the certificate and all intermediate certificates in a text editor.
Line 22: Line 22:
 
# Check correct certificate chain here at [http://www.digicert.com/help/ digicert] (maybe only possible after you finished setup).
 
# Check correct certificate chain here at [http://www.digicert.com/help/ digicert] (maybe only possible after you finished setup).
  
== Setting up the sub-provider ==
+
== Setting up the subprovider ==
 
Please ensure that all prerequisites are fulfilled. Now follow these steps:
 
Please ensure that all prerequisites are fulfilled. Now follow these steps:
  
 
=== Setting up in appliance menu ===
 
=== Setting up in appliance menu ===
 
# Enter appliance menu and chose "Network..." -> "Add IP" to add the public IP address (if not yet done).
 
# Enter appliance menu and chose "Network..." -> "Add IP" to add the public IP address (if not yet done).
# Enter "Provider..." -> "Add sub-provider" option.
+
# Enter "Provider..." -> "Add subprovider" option.
# Choose the added IP address (internal address if behind firewall, router or load-balancer).
+
# Choose the IP address added (internal address if behind firewall, router or load-balancer).
# Enter the server name of the new sub-provider and answer all questions asked by the system.
+
# 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 sub-provider from the menu
+
# 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)
+
# 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
+
# If the provider system is running a cross-master replication, ensure that you also configure the other system in the same manner.
  
 
=== Setting up in web administration ===
 
=== Setting 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
 
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 sub-providers". The new sub-provider should appear in the list of sub-providers
+
# 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 sub-provider in the list of sub-providers allows you to edit the settings in the lower area "Edit provider settings"
+
# 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 sub-provider and finish it by clicking "Save changes"
+
# Complete the settings of the new subprovider and finish it by clicking "Save changes".
  
 
=== Admin-Account and Customization ===
 
=== Admin-Account and Customization ===
Upon successful sub-provider creation, you need some administrator user for this sub-provider to edit customization:
+
Once the subprovider has been successfully created, you need an administrator user for this subprovider to edit and do customization:  
# Let the new admin sign up for a regify account on the new sub-provider.
+
# New admin signs up for a regify account on the new subprovider.
 
# Activate from the email and note your password.
 
# Activate from the email and note your password.
# Login to main(!) provider administration -> "Manage sub-providers" (with existing main(!) provider admin account).
+
# Login to main(!) provider administration -> "Manage subproviders" (with existing main(!) provider admin account).
# Go "Manage sub-providers".
+
# Go to "Manage subproviders".
# Select the sub-provider in the list to add the admin user to.
+
# Select the subprovider in the list to add the admin user to.
 
# Click on "Manage portal administration roles" in the "Common" tab below.
 
# Click on "Manage portal administration roles" in the "Common" tab below.
# Enter the new user as "Sub-Provider Admin" (you can user the "..." button to search the user ID).
+
# Enter the new user as "Subprovider Admin" (you can user the "..." button to search the user ID).
# Log-out from administration.
+
# Log-out from administration screen.
# The new admin now can log-in to https://sub-provider-domain/ADMINISTRATION
+
# The new admin now can log-in to https://subprovider-domain/ADMINISTRATION
  
 
=== ToDo's ===
 
=== ToDo's ===
Upon the new admin log-in to his web-administration, he will see some ToDo's for sure. Please follow these to make sure that everything is set up correctly. Do not only click on "Done" if it is not really done.
+
When the new admin logs into the web administration function, he / she will see some ToDo's. Please follow these to make sure that everything is set up correctly. Do not click on "Done" if all tasks are not really done.  
  
== Delete a sub-provider ==
+
== Delete a subprovider ==
In order to get deleted, a sub-provider must be empty. So saying, not a single user is assigned to this sub-provider anymore. Normally, all users are getting exported/imported to some other system or moved to another sub-provider.  
+
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, only admin accounts are left. Please follow these steps to get rid of the sub-providers admin users:
+
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 with "master" admin role and remove any admin roles for the affected sub-provider except the one for the last and final administrator of the sub-provider.
+
# 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 to the sub-provider administration.
+
# 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 (you). You can not delete this account, because it is still an admin!
+
# 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"
 
# Select "Action" - "Change the user data"
# On the bottom of the dialog, please switch the "Sub-Provider" to the main provider domain and click on "Save changes".
+
# 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, please close the window, go back to main page and log out.
# Now, you have to enter the main provider administration with "master" admin role and finally remove the admin role for the affected sub-provider. The "Master" role of the main provider admin may stay here and may not get deleted.
+
# 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 sub-provider can get deleted by the SSH appliance menu.
+
Finally, the subprovider can be deleted by the SSH appliance menu.

Revision as of 12:15, 19 August 2019

Prerequisites and information

IMPORTANT: Before setting up a new subprovider, please read the generic article about subproviders: Subprovider

Network

  1. You need a new public IPv4 IP address for a subprovider.
  2. If the regify provider is directly connected to the internet
    • Enter the public IP to the regify provider appliance
  3. 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.
  4. A new DNS A-record must be made to route your new domain (like subprovider.company.com) to the new public IP address.
  5. 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.

Certificate

How to buy a SSL certificate for the subprovider domain:

  1. Whilst setting up the new subprovider in your appliance menu, a new certificate is generated.
  2. You can display the signing request by choosing "Show Cert Request" in the appliance menu. Fill in the fields.
  3. Copy and use the signing request to order your certificate.
  4. If received, collect the certificate and all intermediate certificates in a text editor.
  5. Import certificate using "Import Cert & Optionally Key" from appliance menu and past text editor content.
  6. 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:

Setting up in appliance menu

  1. Enter appliance menu and chose "Network..." -> "Add IP" to add the public IP address (if not yet done).
  2. Enter "Provider..." -> "Add subprovider" option.
  3. Choose the IP address added (internal address if behind firewall, router or load-balancer).
  4. Enter the server name of the new subprovider and answer all questions asked by the system.
  5. Select "Edit Subprovider..." in the appliance menu and chose the added subprovider from the menu.
  6. Import the SSL certificate using "Import Cert & Optionally key" from the appliance menu (not needed if the load balancer holds the certificates).
  7. If the provider system is running a cross-master replication, ensure that you also configure the other system in the same manner.

Setting 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

  1. 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.
  2. Selecting the new subprovider in the list of subproviders allows you to edit the settings in the lower area "Edit provider settings".
  3. 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:

  1. New admin signs up for a regify account on the new subprovider.
  2. Activate from the email and note your password.
  3. Login to main(!) provider administration -> "Manage subproviders" (with existing main(!) provider admin account).
  4. Go to "Manage subproviders".
  5. Select the subprovider in the list to add the admin user to.
  6. Click on "Manage portal administration roles" in the "Common" tab below.
  7. Enter the new user as "Subprovider Admin" (you can user the "..." button to search the user ID).
  8. Log-out from administration screen.
  9. The new admin now can log-in to https://subprovider-domain/ADMINISTRATION

ToDo's

When the new admin logs into the web administration function, he / she will see some ToDo's. Please follow these to make sure that everything is set up correctly. Do not click on "Done" if all tasks are not really done.

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:

  1. 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.
  2. Now, log-in with this last admin user name to the subprovider administration screen.
  3. 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!
  4. Select "Action" - "Change the user data"
  5. On the bottom of the dialogue box, please switch the "Subprovider" to the main provider domain and click on "Save changes".
  6. Now, please close the window, go back to main page and log out.
  7. 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.