fossbilling-epp-isnic/README.md

76 lines
2.4 KiB
Markdown
Raw Normal View History

2023-02-16 14:18:43 +00:00
# Compatibility
This module is supposed to work with:
- Any Generic RFC EPP registry.
- Caucasus Online - .ge
- CentralNic - all
- CoCCA - all
2023-02-16 15:55:23 +00:00
- CORE/Knipp - all
2023-02-16 14:18:43 +00:00
- GoDaddy Registry - all
- Google Nomulus - all
- HKIRC - .hk
2023-02-16 15:36:05 +00:00
- Identity Digital - all
2023-02-16 14:18:43 +00:00
- RoTLD - .ro
2023-02-16 16:02:30 +00:00
- RyCE - all
2023-02-16 14:18:43 +00:00
- SIDN - all
- ZADNA - .za
2023-02-16 15:39:30 +00:00
- ZDNS - .all
2023-01-10 20:04:32 +00:00
# FOSSBilling Module Installation instructions
2023-07-13 12:37:29 +00:00
## 1. Download and Install FOSSBilling:
2023-01-10 20:04:32 +00:00
2023-07-13 12:37:29 +00:00
Start by downloading the latest version of FOSSBilling from the official website (https://fossbilling.org/). Follow the provided instructions to install it.
2023-01-10 20:04:32 +00:00
2023-07-13 12:37:29 +00:00
## 2. Installation and Configuration of Registrar Adapter:
2023-01-10 20:04:32 +00:00
2023-07-13 12:37:29 +00:00
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.
2023-01-10 20:04:32 +00:00
2023-07-13 12:37:29 +00:00
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:
There are two additional scripts in the repository: **eppSync.php** and **Tembo.php**. These need to be placed in the main `[FOSSBilling]` directory.
Rename `eppSync.php` to `YourRegistryNameSync.php`.
2023-07-13 12:40:06 +00:00
Edit `eppSync.php` and replace **Epp** in the line `$registrar = "Epp";` with the name of your registry provided in step 2.
2023-07-13 12:37:29 +00:00
## 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.
Add the following cron job:
`0 0,12 * * * php /var/www/html/YourRegistryNameSync.php`
This command schedules the synchronization script to run once every 12 hours (at midnight and noon).
## 5. Activate the Domain Registrar Module:
Within FOSSBilling, go to **System -> Domain Registration -> New Domain Registrar** and activate the new domain registrar.
## 6. Registrar Configuration:
Next, head to the "**Registrars**" tab. Here, you'll need to enter your specific configuration details, including the path to your SSL certificate and key.
## 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.