refactor: adapt module for ISNIC EPP compatibility

Renamed and refactored the module files and classes from a generic EPP implementation to specifically support ISNIC's EPP server requirements. Adjusted the README to reflect this transition, focusing on setting up the module for ISNIC rather than a broad range of registrars. This change enables the module to work seamlessly with ISNIC's EPP server, ensuring users can register and synchronize .is TLDs effectively within the FOSSBilling system. The update includes renaming epp.php to ISNIC.php, eppSync.php to ISNICSync.php, and refocusing the documentation on ISNIC-specific setup and configuration.

This modification was crucial for users aiming to integrate FOSSBilling with ISNIC, streamlining the process and reducing setup complexities.
This commit is contained in:
Kumi 2024-05-19 18:31:45 +02:00
parent 2d52bfb1b9
commit 66c0c8e0e6
Signed by: kumi
GPG key ID: ECBCC9082395383F
3 changed files with 10 additions and 44 deletions

View file

@ -8,7 +8,7 @@
* *
* @license MIT * @license MIT
*/ */
class Registrar_Adapter_EPP extends Registrar_AdapterAbstract class Registrar_Adapter_ISNIC extends Registrar_AdapterAbstract
{ {
public $config = array(); public $config = array();
public $socket; public $socket;

View file

@ -5,7 +5,7 @@ use Pinga\Tembo\eppClient;
$config = include "config.php"; $config = include "config.php";
$c = $config["db"]; $c = $config["db"];
$registrar = "Epp"; $registrar = "ISNIC";
try try
{ {

View file

@ -1,34 +1,8 @@
# Compatibility # ISNIC EPP Module for FOSSBilling
This module is designed for use with: This is a fork of the [fossbilling-epp-rfc](https://github.com/getpinga/fossbilling-epp-rfc) module that has been modified to work with ISNIC's EPP server.
- Any Generic RFC EPP registry. The following instructions are from the original README.md file.
- Caucasus Online - .ge
- CentralNic - all
- CoCCA - all
- CORE/Knipp - all
- GoDaddy Registry - all
- Google Nomulus - all
- HKIRC - .hk
- Identity Digital - all
- RoTLD - .ro
- RyCE - all
- SIDN - all
- ZADNA - .za
- ZDNS - .all
# FOSSBilling Module Installation instructions # FOSSBilling Module Installation instructions
@ -38,27 +12,19 @@ Start by downloading the latest version of FOSSBilling from the official website
## 2. Installation and Configuration of Registrar Adapter: ## 2. Installation and Configuration of Registrar Adapter:
First, download this repository which contains the epp.php file. After successfully downloading the repository, move the epp.php file into the `[FOSSBilling]/library/Registrar/Adapter` directory. First, download this repository which contains the epp.php file. After successfully downloading the repository, move the ISNIC.php file into the `[FOSSBilling]/library/Registrar/Adapter` directory.
Next, rename `epp.php` as `YourRegistryName.php`. Please ensure to replace "**YourRegistryName**" with the actual name of your registry.
Proceed to open the newly renamed file and locate the phrase "**Registrar_Adapter_EPP**". Replace it with "**Registrar_Adapter_YourRegistryName**".
## 3. Addition of Synchronization Scripts: ## 3. Addition of Synchronization Scripts:
There are two additional scripts in the repository: **eppSync.php** and **eppClient.php**. These need to be placed in the main `[FOSSBilling]` directory. There are two additional scripts in the repository: **ISNICSync.php** and **eppClient.php**. These need to be placed in the main `[FOSSBilling]` directory.
Rename `eppSync.php` to `YourRegistryNameSync.php`.
Edit `eppSync.php` and replace **Epp** in the line `$registrar = "Epp";` with the name of your registry provided in step 2.
## 4. Setting Up the Cron Job: ## 4. Setting Up the Cron Job:
You need to set up a cron job that runs the sync module twice a day. Open crontab using the command `crontab -e` in your terminal. You need to set up a cron job that runs the sync module twice a day. Open crontab using the command `crontab -e` in your terminal.
Add the following cron job: Add the following cron job (make sure to replace `/var/www/html/ISNICSync.php` with the correct path to the ISNICSync.php file):
`0 0,12 * * * php /var/www/html/YourRegistryNameSync.php` `0 0,12 * * * php /var/www/html/ISNICSync.php`
This command schedules the synchronization script to run once every 12 hours (at midnight and noon). This command schedules the synchronization script to run once every 12 hours (at midnight and noon).
@ -72,4 +38,4 @@ Next, head to the "**Registrars**" tab. Here, you'll need to enter your specific
## 7. Adding a New TLD: ## 7. Adding a New TLD:
Finally, add a new Top Level Domain (TLD) using your module from the "**New Top Level Domain**" tab. Make sure to configure all necessary details, such as pricing, within this tab. Finally, add the .is Top Level Domain (TLD) using at the "**New Top Level Domain**" tab. Make sure to configure all necessary details, such as pricing, within this tab.