IPMirror - Revision history

JuanR: /* Automatic Domain Synchronization */

2023-06-07T12:19:13Z

‎Automatic Domain Synchronization

SarahK: /* Activation */

2022-04-11T21:23:27Z

‎Activation

SarahK at 21:22, 11 April 2022

2022-04-11T21:22:22Z

SarahK at 18:21, 1 October 2021

2021-10-01T18:21:17Z

SarahK at 18:40, 4 August 2020

2020-08-04T18:40:16Z

Nathan at 15:50, 30 January 2018

2018-01-30T15:50:59Z

Andrew at 14:57, 23 September 2013

2013-09-23T14:57:23Z

Andrew at 10:22, 29 January 2013

2013-01-29T10:22:17Z

Andrew: /* Configuration */

2012-10-18T13:49:27Z

‎Configuration

John at 12:05, 16 October 2012

2012-10-16T12:05:05Z

@@ Line 81: / Line 81: @@
 == Automatic Domain Synchronization ==
-−
 This module supports automatic domain synchronization for syncing expiry dates and status changes for incoming transfers.
-−
-To use this, enable '''Domain Sync Enabled''' in the '''[[Domains_Tab|Domains]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''. You must also make certain to configure the '''[[Crons#Domain_Sync_Cron|Domain Sync Cron]]'''.
+To use this, enable '''Domain Sync Enabled''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.
 ==Troubleshooting==

@@ Line 22: / Line 22: @@
 # Find '''Ipmirror''' in the list.
 # Click '''Activate'''.
-# Enter your IPMirror credentials using the [[#Configuration configuration]] below.
+# Enter your IPMirror credentials using the [[#Configuration|configuration]] below.
 # Click '''Save Changes'''.

@@ Line 1: / Line 1: @@
 {{registrar
 | register = yes
@@ Line 11: / Line 14: @@
 | domainsync = yes
 }}
-==Activation==
+To activate and begin using the Ipmirror registrar module:
-# Log in to your WHMCS Admin Area
+# Log in to the WHMCS Admin Area.
-# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Domain Registrars''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
+# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Registrars]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
-# Click '''Activate''' for '''Ipmirror'''.
+# Find '''Ipmirror''' in the list.
 # Click '''Save Changes'''.
 ===Requirements===
 The Ipmirror module connects WHMCS with the ccTLD Box Registrar Application Interface (RAPI). This allows WHMCS to pass certain domain operations (for example, domain registrations) to IPMirror’s ccTLD Box in real time without manual intervention. To access ccTLD Box through RAPI, you must:
 * Obtain valid ccTLD Box partner account with IPMirror.
 * Update IPMirror's firewall configuration with the IP address of the WHMCS server(s) you plan to use.
-*  Find your partner-specific URL to the ccTLD Box RAPI.
+* Find your partner-specific URL to the ccTLD Box RAPI.
 ===Configuration===
 {| class="wikitable"
 !colspan="2"|Setting Name: DebugMode
@@ Line 65: / Line 74: @@
 |}
-==Automatic Registration==
+== Automatic Registration ==
-WHMCS allows you to set up automatic domain registration on a per extension-basis.
-To enable automatic registration, see [[Domain Pricing|Configuring Automatic Registration]].
+To use this, enable '''Domain Sync Enabled''' in the '''[[Domains_Tab|Domains]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''. You must also make certain to configure the '''[[Crons#Domain_Sync_Cron|Domain Sync Cron]]'''.
-==Automatic Domain Synchronization==
+==Troubleshooting==
-To enable this, you must enable '''Domain Sync Enabled''' in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Domains''' or, prior to WHMCS 8.0, '''Setup > General Settings > Domains''' and configure the [[Crons#Domain_Sync_Cron|Domain Sync Cron]]  on your system.
+''N/A''
 {{modules}}

@@ Line 13: / Line 13: @@
 ==Activation==
-To activate and begin using the Ipmirror registrar module, follow the steps below:
+To activate and begin using the Ipmirror registrar module::
-# Login to your WHMCS Admin Area
+# Log in to your WHMCS Admin Area
-# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Domain Registrars''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
+# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Domain Registrars''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
-# Locate Ipmirror in the list
+# Click '''Activate''' for '''Ipmirror'''.
-# Click the '''Activate''' button
+# Click '''Save Changes'''.
 ===Requirements===
-The Ipmirror module connects WHMCS with the ccTLD Box Registrar Application Interface (RAPI). This allows WHMCS to pass certain domain operations (e.g. domain registrations etc.) through to IP Mirror’s ccTLD Box in real-time without any manual intervention. In order to access ccTLD Box through RAPI you will need to the following information from IP Mirror:
+The Ipmirror module connects WHMCS with the ccTLD Box Registrar Application Interface (RAPI). This allows WHMCS to pass certain domain operations (for example, domain registrations) to IPMirror’s ccTLD Box in real time without manual intervention. To access ccTLD Box through RAPI, you must:
-* A valid ccTLD Box partner account with IP Mirror
+* Obtain valid ccTLD Box partner account with IPMirror.
-* Inform IP Mirror about the IP address of the WHMCS server(s) you plan to use the interface on, so that the firewall can be configured accordingly
+* Update IPMirror's firewall configuration with the IP address of the WHMCS server(s) you plan to use.
-*  Your partner-specific URL to the ccTLD Box RAPI
+*  Find your partner-specific URL to the ccTLD Box RAPI.
 ===Configuration===
@@ Line 33: / Line 31: @@
 !colspan="2"|Setting Name: DebugMode
 |-
-|colspan="2"|The user login name given to you by IP Mirror to access your ccTLD Box.
+|colspan="2"|The IPMirror username to access your ccTLD Box.
 |-
 !colspan="2"|Setting Name: Password
 |-
-|colspan="2"|The password given to you to access your ccTLD Box.
+|colspan="2"|The password to access your ccTLD Box.
 |-
 !colspan="2"|Setting Name: ccTLDBoxUrl
 |-
-|colspan="2"|The URL to access your ccTLD Box RAPI. This has usually the form <nowiki>https://</nowiki><partnerdomain>/RAPI/ (where <partnerdomain> is the domain given to you to access your ccTLD Box).
+|colspan="2"|The URL to access your ccTLD Box RAPI. This generally uses the <tt><nowiki>https://</nowiki><partnerdomain>/RAPI/</tt> format, where <tt><partnerdomain></tt> is the domain for your ccTLD Box.
 |-
 !colspan="2"|Setting Name: AllowAdminContactChange
 |-
-|colspan="2"|If ticked, a client logged on to the WHMCS client area can see and modify the administrative/contacts of a domain (WHMCS administrators can always see/modify all contacts). Not recommended for those contacts for which a default contact Id (see below) is specified.
+|colspan="2"|If you enable this, a client logged in to the WHMCS Client Area can see and modify the administrative information and contacts for a domain. WHMCS administrators can always see and modify all contacts. We do not recommend this for contacts with a specified contact ID.
 |-
 !colspan="2"|Setting Name: DefaultRegContactId
 |-
-|colspan="2"|If this field is filled with a valid (i.e. existing) ccTLD Box contact Id, this same contact will always be used as the registrant contact for new domains. Usually, this box is not ticked in order to have a separate registrant contact for each domain.
+|colspan="2"|If this is a valid, existing ccTLD Box contact ID, this contact will always be the registrant contact for new domains. Usually, you should disable this in order to have a separate registrant contact for each domain.
 |-
 !Setting Name: ConnectionTimeout
@@ Line 64: / Line 62: @@
 !Recommended Value: Off
 |-
-|colspan="2"|Tick this to output debug information such as parameters, function calls etc. onscreen (the synchronization script will output the information to the console). This only works for users with administrator privileges. Please be careful and only use this option when asked to provide debug information by IP Mirror, and do not forget to uncheck it again afterwards.
+|colspan="2"|Enable this to output debug information like parameters or function calls onscreen, with the synchronization script outputting the information to the console. This only works for users with admin privileges. Only use this option to provide debugging information to IPMirror, and disable it immediately afterwards.
 |}
 ==Automatic Registration==
-WHMCS allows you to setup automatic domain registration on a per extension basis enabling you to use different registrars for different TLDs to give you the flexibility to offer more extensions and always get the best value.
+WHMCS allows you to set up automatic domain registration on a per extension-basis.
-To enable automatic registration, please refer to [[Domain Pricing|Configuring Automatic Registration]]
+To enable automatic registration, see [[Domain Pricing|Configuring Automatic Registration]].
 ==Automatic Domain Synchronization==
-The Ipmirror module supports automatic domain synchronization for syncing of expiry dates and status changes for incoming transfers.
+The IPMirror module supports automatic domain synchronization for expiry dates and status changes for incoming transfers.
-To enable this functionality, you need to ensure you have the '''Domain Sync Enabled''' in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Domains''' or, prior to WHMCS 8.0, '''Setup > General Settings > Domains''' and ensure you have the [[Crons#Domain_Sync_Cron|Domain Sync Cron]] configured on your system.
+To enable this, you must enable '''Domain Sync Enabled''' in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Domains''' or, prior to WHMCS 8.0, '''Setup > General Settings > Domains''' and configure the [[Crons#Domain_Sync_Cron|Domain Sync Cron]]  on your system.
 {{modules}}

@@ Line 16: / Line 16: @@
 # Login to your WHMCS Admin Area
-# Navigate to Setup > Products/Services > Domain Registrars
+# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Domain Registrars''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
 # Locate Ipmirror in the list
 # Click the '''Activate''' button
@@ Line 75: / Line 75: @@
 The Ipmirror module supports automatic domain synchronization for syncing of expiry dates and status changes for incoming transfers.
-To enable this functionality, you need to ensure you have the '''Domain Sync Enabled''' in Setup > General Settings > Domains and ensure you have the [[Crons#Domain_Sync_Cron|Domain Sync Cron]] configured on your system.
+To enable this functionality, you need to ensure you have the '''Domain Sync Enabled''' in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Domains''' or, prior to WHMCS 8.0, '''Setup > General Settings > Domains''' and ensure you have the [[Crons#Domain_Sync_Cron|Domain Sync Cron]] configured on your system.
 {{modules}}

@@ Line 9: / Line 9: @@
 | dnsmanagement = yes
 | emailforwarding = yes
 }}

← Older revision		Revision as of 10:22, 29 January 2013
Line 36:		Line 36:
	'''DebugMode''' - Tick this to output debug information such as parameters, function calls etc. onscreen (the synchronization script will output the information to the console). This only works for users with administrator privileges. Please be careful and only use this option when asked to provide debug information by IP Mirror, and do not forget to uncheck it again afterwards.		'''DebugMode''' - Tick this to output debug information such as parameters, function calls etc. onscreen (the synchronization script will output the information to the console). This only works for users with administrator privileges. Please be careful and only use this option when asked to provide debug information by IP Mirror, and do not forget to uncheck it again afterwards.
	Recommended setting: Off		Recommended setting: Off
		+
		+	{{modules}}

@@ Line 24: / Line 24: @@
 '''Password''' - The password given to you to access your ccTLD Box
-'''ccTLDBoxUrl''' - The URL to access your ccTLD Box RAPI. This has usually the form https://<partnerdomain>/RAPI/ (where <partnerdomain> is the domain given to you to access your ccTLD Box).
+'''ccTLDBoxUrl''' - The URL to access your ccTLD Box RAPI. This has usually the form <nowiki>https://</nowiki><partnerdomain>/RAPI/ (where <partnerdomain> is the domain given to you to access your ccTLD Box).
 '''AllowAdminContactChange''' - If ticked, a client logged on to the WHMCS client area can see and modify the administrative/contacts of a domain (WHMCS administrators can always see/modify all contacts). Not recommended for those contacts for which a default contact Id (see below) is specified.

← Older revision		Revision as of 12:05, 16 October 2012
Line 10:		Line 10:
	\| emailforwarding = yes		\| emailforwarding = yes
	}}		}}
		+
		+	==Requirements==
		+	The IP Mirror module connects WHMCS with the ccTLD Box Registrar Application Interface (RAPI). This allows WHMCS to pass certain domain operations (e.g. domain registrations etc.) through to IP Mirror’s ccTLD Box in real-time without any manual intervention. In order to access ccTLD Box through RAPI you will need to the following information from IP Mirror:
		+	*A valid ccTLD Box partner account with IP Mirror
		+	*Inform IP Mirror about the IP address of the WHMCS server(s) you plan to use the interface on, so that the firewall can be configured accordingly
		+	*Your partner-specific URL to the ccTLD Box RAPI
		+
		+	==Configuration==
		+	To setup the IP Mirror Registrar integration in WHMCS, begin by going to '''Setup > Products/Services > Domain Registrars'''. Next choose Ipmirror from the dropdown menu of available registrars and click Go to view the configurable options for it. An explanation of each option can be found below:
		+
		+	'''Username''' - The user login name given to you by IP Mirror to access your ccTLD Box
		+
		+	'''Password''' - The password given to you to access your ccTLD Box
		+
		+	'''ccTLDBoxUrl''' - The URL to access your ccTLD Box RAPI. This has usually the form https://<partnerdomain>/RAPI/ (where <partnerdomain> is the domain given to you to access your ccTLD Box).
		+
		+	'''AllowAdminContactChange''' - If ticked, a client logged on to the WHMCS client area can see and modify the administrative/contacts of a domain (WHMCS administrators can always see/modify all contacts). Not recommended for those contacts for which a default contact Id (see below) is specified.
		+
		+	'''DefaultRegContactId''' - If this field is filled with a valid (i.e. existing) ccTLD Box contact Id, this same contact will always be used as the registrant contact for new domains. Usually, this box is not ticked in order to have a separate registrant contact for each domain.
		+
		+	'''ConnectionTimeout''' - Time in seconds for the interface to wait to connect to ccTLD Box. Recommended setting: 20 (seconds)
		+
		+	'''ExecutionTimeout''' - Time in seconds for the interface to wait for ccTLD Box to execute a command. Recommended setting: 60 (seconds)
		+
		+	'''DebugMode''' - Tick this to output debug information such as parameters, function calls etc. onscreen (the synchronization script will output the information to the console). This only works for users with administrator privileges. Please be careful and only use this option when asked to provide debug information by IP Mirror, and do not forget to uncheck it again afterwards.
		+	Recommended setting: Off