Domains plugin

The Domains Fleio plugin adds domain name registration and management functionality to Fleio. The plugins allows you to register and manage domain names, define what TLDs are supported and define registrars to be used for registration and management of domain names.

Registrars

First step in using Domains plugin is to configure registrars. The registrars can be configured from staff panel by accessing Domains/Registrars menu.

In this page you can edit the internet domain name registrars:

../_images/registrars.png

To add a new registrar click the plus button on the bottom of the page. When adding a registrar you need to choose a registrar connector. The Domains plugin provides several registrar connectors that can be used:

../_images/registrar-add.png

Once a registrar is added you can edit it to change name and connector, the edit registrar dialog will be displayed:

../_images/registrar-edit.png

Once you made the changes you wanted you can hit save and the registrar will be saved.

If you want to delete a registrar click the Delete button on registrar actions. A confirmation dialog will be displayed:

../_images/registrar-delete.png

Clicking the Delete button will delete the registrar.

When you define a registrar you will have to select a registrar connector. Fleio supports the following connectors:

TODO registrar connector

The TODO registrar connector will add TODOs when an action for a domain is executed. This connector required TODO plugin to be installed and enabled in order to work

Open Provider registrar connector

The Open Provider registrar connector will execute domain action using Open Provider registrar. In order to use this connector a valid configuration must be specified in settings.py

Reseller Club registrar connector

The Reseller Club registrar connector will execute domain action using Reseller Club registrar. In order to use this connector a valid configuration must be specified in settings.py

TLDs

In order to be able to register, transfer or renew domains you need to configure TLDs and define prices for domains. E.g. if you want to allow .com domains ordering you should define a TLD named .com and then click on it to edit pricing. TLDs can be managed by accessing Domains/TLDs menu in staff panel.

In this page you can edit the TLDs:

../_images/tlds.png

To add a new TLD click the plus button on the bottom of the page. When adding a TLD you need to specify a valid top level domain name, including the dot:

../_images/tld-add.png

Once a TLD is added you can edit it to change the top level domain name, the edit TLD dialog will be displayed:

../_images/tld-edit.png

Once you made the changes you wanted you can hit save and the TLD will be saved.

If you want to delete a TKD click the Delete button on TLD actions. A confirmation dialog will be displayed:

../_images/tld-delete.png

Clicking the Delete button will delete the TLD.

If you click on a TLD you will be redirected to the TLD details page where you can edit domain name registration prices, domain name addons prices, change registrar settings, see cost prices and custom fields.

On the pricing tab in TLD details you can change registration prices for the domain name:

../_images/tld-details-pricing.png

In order to ease the price defining you can auto-fill prices and use relative prices for non default currencies. Once you are done editing you can click the Save prices button to save the prices.

On the addons pricing tab in TLD details you can change addons prices for the domain name:

../_images/tld-details-addons-pricing.png

In order to ease the price defining you can auto-fill prices and use relative prices for non default currencies. Once you are done editing you can click the Save addons prices button to save the prices.

On the registrar tab you can select the default registrar and specify if EPP code is needed in order to transfer domains for this TLD:

../_images/tld-details-registrars.png

Once you are done you can click Save registrars button to save your changes.

On the cost pricing tab you can see the actual price you will pay for the domains with this TLD for various operations:

../_images/tld-details-cost-pricing.png

On the custom fields tab you can see the custom fields required on client or domain contact in order to be able to register a domain with this TLD:

../_images/tld-details-custom-fields.png

Domains

Domains can be managed either from staff panel or from user panel by accessing Domains/Domains menu.

A staff user will see all domains and will be able to delete or edit domains and also will usually have more options available to manage a domain compared to a end user.

A end user will only have access to his domains and will have fewer options available.

Domains cannot be added directly, in order to add a domain the end user will have to place an order to either register or transfer a domain. Once the order is placed the domain will appear in Domains/Domain

Staff can delete domains. When you click delete button on domain actions the delete dialog will be displayed:

../_images/domain-delete.png

clicking Delete button will delete the domain.

Staff can also edit a domain. When you click edit button on domain actions the edit domain dialog will be displayed:

../_images/domain-edit.png

if you want to change domain name it will have to have the same TLD. Once you are done editing you can click Save domain button to save changes.

Clicking on a domain will open the domain details page. Several tabs are present on domain details page.

The general tab

../_images/domain-details-general.png

will show you info about the domain and allow you to perform domain actions based on current domain status and the selected registrar.

The nameservers tab

../_images/domain-details-nameservers.png

will allow you to edit the nameservers for the domain.

The whois information tab

../_images/domain-details-whois-information.png

will allow you to edit whois information for the domain if available.

Registering a domain

To register a domain the end user must access Domains/Register domain menu, check if the domain is available, fill up the required data and then add the domain to cart and place an order.

For the staff user the register domain operation will not check for availability and once you fill up all the data a Place order button will be available that will create an order with the selected domain.

../_images/domain-register.png

Transfer a domain

To transfer a domain the end user must access Domains/Transfer domain menu, check if the domain is available, fill up the required data and then add the domain to cart and place an order.

For the staff user the transfer domain operation will not check for availability and once you fill up all the data a Place order button will be available that will create an order with the selected domain.

../_images/domain-transfer.png

Domains plugin configuration options

The Domains plugin can be enabled/disabled via feature toggle and has some configurations options that can be set in settings.py file.

Feature configuration

In order for the plugin to be enabled and visible in UI both plugins and plugins.domains features should be set to True. This should be done for both staff and end user.

Registrar connectors configuration

In order for Open Provider and Reseller Club connector to work you need to configure them in settings.py file. The configuration should look like below - just replace <user> and <key> with your user and key from the registrar:

REGISTRARS = {
   'resellerclub': {
       'test': True,
       'auth_userid': '<user>',
       'api_key': '<key>'
   },
   'openprovider': {
       'membership_cost': '0.00',
       'user_id': '<user>',
       'access_hash': '<key>',
   }
}

Domains plugin settings

The Domains plugin has some configurable settings that can be edited when editing client configurations by accessing Setting/Configurations menu. Right now you can configure a default TLD and the default nameservers to be used for domain names registration.