updates to readme and documentation

CHANGELOG.md

@@ -1,15 +1,76 @@
 # Changelog
-## DOMAIN TRANSFER
 
-## V3.4.1
+## v5.4
+
+###### Features and improvements
+
+- 
+
+###### Bugfixes
+
+- 
+
+## v5.3
+
+###### Features and improvements
+
+- Allow end users and WHMCS administrators to update domain contact  details for .es domains, including the company / personal identification number
+
+###### Bugfixes
+
+- Fixes issue with DNSSEC domain validation
+
+## v5.0
+
+###### Features and improvements
+
+- Migrated the module from the Openprovider XML API to use the Openprovider REST API.
+- Control the maximum period for price imports.
+- Added option for partners to use Placement+ domain search
+
+###### Bugfixes
+
+- various bugfixes and improvements
+- Fixes issue where WHMCS domain sync would not update domain expiration dates in some cases
+
+## v4.0.3
+
+###### Bugfixes
+
+- Fixes issue with DNSSEC domain validation
+
+## v4.0.2
+
+###### Bugfixes
+
+- Fixes issue with unnecessary variable type
+- Fixes "getting oops error with mixed registrars"
+- Updates menu item & API scripts' absolute path
+
+## v4.0.1
+
+###### Features
+
+- Added support for Domain contact verification, for more information see the [WHMCS documentation](https://docs.whmcs.com/Domain_Contact_Verification)
+- [Support for tag management of clients](https://github.com/openprovider/OP-WHMCS7#allow-end-users-to-edit-dnssec-records)
+- Simplified configuration page
+- [Allow end users to manage DNSSEC records](https://github.com/openprovider/OP-WHMCS7#allow-end-users-to-edit-dnssec-records)
+- Refactored documentation
+
+###### Bugfixes
+
+- Fixes issue with unnecessary variable type
+
+## v3.4.1
+
 - [FEATURE] Added support for TLD price caching.
 - [IMPROVEMENT] Simplified login page and moved advanced configuration options to a file
 - [BUGFIX] Incorrect credentials were sometimes not being indicated when activating the module
 - [FEATURE] Allow end users to manage DNSSEC settings on their domains
 - [FEATURE] Added support for WHMCS feature domain verification as described in [the WHMCS documentaitno](https://docs.whmcs.com/Domain_Contact_Verification)
 - [FEATURE] Adds support for assigning tags to specific clients, which allows the WHMCS administrator to send custom emails to the client and all of the client's contacts
 
-## V3.3
+## v3.3
 Notes:
 To improve DNS support, perform the actions are instructed in "Install the DNS management options". We have created a [request for WHMCS to make this easier. Please upvote this request here](https://requests.whmcs.com/topic/add-support-for-custom-dns-types).
 
@@ -23,15 +84,15 @@ To improve DNS support, perform the actions are instructed in "Install the DNS m
 - Improvement: #132 Remove non-required .de required fields
 - Improvement: #148 Skip domains marked as fraud in synchronisation
 
-## V3.1
+## v3.1
 
 - Feature: Execute renewal action for free domain transfers (#126)
 - Bugfix: Removed the by WHMCS introduced field "Eurid Entity type" for .eu (#130)
 - Bugfix: Fixed addon activation (#119)
 - Bugfix: Domains in Pending transfer are skipped by DomainSync (#131)
 
 
-## All previous versions to V3.0
+## All previous versions to v3.0
 
 Manual action required: Check step 12 of hte installation manual in order to remove the domain lock warning for certain TLDs.
 

README.md

@@ -29,7 +29,7 @@ Features
 ```
 if (function_exists('openprovider_additional_fields'))
     $additionaldomainfields = openprovider_additional_fields();
-``` 
+```
 - [Optional] Upload `<Module directory>/modules/addons/openprovider` to `<WHMCS directory>/modules/addons`
 ## Basic Configurations
 
@@ -71,6 +71,14 @@ First Make sure that the currency that you are using to pay Openprovider is conf
 2. Configure premium pricing and margins
 3. In the Advanced configuration file of the module ( `/modules/registrars/openprovider/configuration/advanced-module-configurations.php`) find the parameter "OpenproviderPremium" and set to **true**
 
+### Start selling Premium DNS service
+
+Openprovider’s premium DNS leverages Sectigo’s advanced DNS infrastructure to provide a single, integrated and easy to adopt solution which offers a 99.99% Uptime Guarantee and near real-time updates, features DDoS protection and blazing fast resolution. While our standard DNS service is sufficient for users who don’t have any special needs when it comes to DNS resolution, the premium DNS service can be an excellent service to your hosting services portfolio.
+
+- Copy the contents of `/modules/servers/openprovidersectigodns` to `<your-WHMCS-directory>/modules/servers/openprovidersectigodns`
+- Set up a product with the Openprovider-premiumDNS module (make sure to require a domain) and start selling. [See here for detailed setup instructions.](docs/premium_dns_product_setup.md) 
+- Note that there is no test environment and records created with the premium DNS module will be billed to your Openprovider account.
+
 ### Allow additional DNS records
 
 If you plan on allowing your end users to edit their own DNS records, and want them to be able to create all record types supported by Openprovider, you can make some modifications to the WHMCS templates as described here:
@@ -110,12 +118,6 @@ Set up tag management to send custom emails to the end users of your resellers.
 
 - [Configuration instructions can be found here](docs/associate_tags_with_customers.md)
 
-### Configure the Openprovider cron sync
-
-If you are concerned that the "out of the box" domain sync included by WHMCS is not sufficient and would like more granular control over domain sync, you can configure the Openprovider sync script. 
-
-- [Configuration instructions can be found here](docs/configure_openprovider_cron_sync.md)
-
 ### Decide whether to use Openprovider Auto-renew
 
 Various options exist for managing domain renewals. A detailed explanation of your options [can be found here](docs/auto_renew_logic.md)
@@ -134,3 +136,10 @@ If there are any connectivity issues with Openprovider, or API commands are not
 ### FAQ
 
 Common issues and solutions for them can be found [here](https://support.openprovider.eu/hc/en-us/articles/360009201193).
+
+
+### [DEPRECATED] Configure the Openprovider cron sync
+
+This feature is deprecated since version 5.3 of the Openprovider domain module, and is not recommended for versions WHMCS 8+. We suggest that you use the WHMCS native domain sync and do not use the Openprovider custom sync for  WHMCS 8 and higher.
+
+- [Configuration instructions can be found here](docs/configure_openprovider_cron_sync.md)

docs/configure_openprovider_cron_sync.md

@@ -1,4 +1,6 @@
-# Openprovider Domain Sync
+# Openprovider Domain Sync - DEPRECATED
+
+This feature is deprecated since version 5.3 of the Openprovider domain module, and is not recommended for versions WHMCS 8+. We suggest that you use the WHMCS native domain sync and do not use the Openprovider custom sync for  WHMCS 8 and higher.
 
 ## Setting up cron task
 

docs/custom_DNS_management_options.md

@@ -18,7 +18,6 @@ To include an SPF and SRV records, you could add the examples shown below:
 ```
 <option value="SPF"{if $dnsrecord.type eq "SPF"} selected="selected"{/if}>SPF</option>
 <option value="SRV"{if $dnsrecord.type eq "SRV"} selected="selected"{/if}>SRV</option>
-<option value="NS"{if $dnsrecord.type eq "NS"} selected="selected"{/if}>NS</option>
 ```
 
 ### Find place to edit which records can be created
@@ -31,7 +30,6 @@ Add the below options to allow end users to create SPF and SRV records.
 ```
 <option value="SPF">SPF</option>
 <option value="SRV">SRV</option>
-<option value="NS">NS</option>
 ```
 
 ### Add priority field if necessary (for example for SRV records)

docs/premium_dns_product_setup.md

@@ -0,0 +1,77 @@
+# Premium DNS setup
+
+Openprovider’s Premium DNS is the latest addition to our product portfolio, and you can offer it to your customers directly via WHMCS. We are extending our successful collaboration with Sectigo, an industry leader in SSL certificates and web security products, to introduce a Premium DNS service that will be the perfect complement to our current, free of charge, standard DNS offering. While our standard DNS service is sufficient for users who don’t have any special needs when it comes to DNS resolution, we recognize the increasing demand of our customers in this area, and we are launching this new product in order to address their needs.
+
+Openprovider’s Premium DNS leverages Sectigo’s advanced DNS infrastructure to provide a single, integrated and easy to adopt solution that offers the following advantages to your customers:
+
+
+
+- **Blazing Fast Resolution**: The first part of a request to your website is typically a DNS lookup. Sectigo’s Premium DNS ensures that your customers are always connected to the closest server, resulting in lower latency and faster access times to your web properties.
+- **Global Presence**: All your DNS zones are pushed to Sectigo’s DNS servers around the globe, ensuring an optimal user experience for your global customers.
+- **DDoS Protection**: DNS is the first step in the journey to your website. Sectigo’s Premium DNS keeps your DNS zone protected from DDoS DNS attacks at all times.
+- **99.99% Uptime Guarantee**: Sectigo’s built-in smart routing and anycast capabilities ensure that your DNS zones are always online. Your websites will always be accessible regardless of regional disruptions.
+- **Near Real-Time Updates**: Updates to your DNS records are carried out globally in near real-time.
+- **Competitive Pricing**
+
+## Technical dependencies
+
+The Premium DNS module can be used with domains from any registrar, not only domains with Openprovider. However, the premium DNS module needs the Openprovider domain module to be activated in WHMCS in order to work correctly, even if you do not use the Openprovider domain module for any domain registrations. 
+
+## Initial Setup
+
+Download the files from our [github repository](https://github.com/openprovider/OP-WHMCS7) 
+
+- Copy the contents of `/modules/registrars/openprovider` to `<your WHMCS directory>/modules/registrars/openprovider`
+- Copy the contents of `/modules/servers/openprovidersectigodns` to `<your WHMCS directory>/modules/servers/openprovidersectigodns`
+- Activate the Openprovider Registrar module in WHMCS. You don’t need to enter credentials unless you are selling Openprovider domains as well
+
+![img](img/activate_module)    
+
+
+
+## Configure premium DNS product
+
+- Navigate to *products/services*, and create an appropriate product group if necessary.
+- Create a new product, and select **Other** as product type and **Openprovider-premiumDNS** from the module dropdown
+- Select the desired product group and name your DNS product something fun.
+
+![img](img/create_new_product_step1)
+
+- After continuing to the *edit product* page: on the *details* tab, check the *require domain* tickbox. 
+- Add the desired description and select welcome email options.
+
+![img](img/create_new_product_step2)
+
+
+
+- Set up pricing on the pricing tab. Consult your Openprovider account to determine the cost price for provisioning premium DNS.
+
+- Under the *module settings* tab, enter the credentials for the Openprovider account with which you’d like to provision premium DNS. Select your desired automation settings for provisioning this product.
+
+
+
+![img](img/create_new_product_step3)
+
+- Configure any other parameters of the product which you deem necessary and then you're ready to start offering premium DNS to your customers.
+
+
+
+## End user workflow in WHMCS basic cart
+
+The below example shows one way the provisioning module can work from the end user point of view. Various upsell options can be implemented via WHMCS to improve .
+
+- End user selects from the categories sidebar “Premium DNS” (the name of your product group where premium DNS is located) and choose a premium DNS product
+
+![img](img/end_user_workflow_step1)
+
+
+
+- Customer will have several options for choosing a domain to be connected with the premium DNS service:
+
+
+
+![img](img/end_user_workflow_step2)
+
+
+
+- Once the customer completes the purchase, the module will provision the premium DNS zone in your Openprovider account.