Documentation Improvement

This commit is contained in:
Pinga 2025-04-19 16:19:18 +03:00
parent 0fe9107cf1
commit 3629ad23e4
7 changed files with 134 additions and 57 deletions

View file

@ -107,17 +107,15 @@ For **older versions**, please refer to [`update.md`](docs/update.md).
#### [Data Encryption](docs/encryption.md)
#### [Custom Pricing per Registrar](docs/custom-registrar-pricing.md)
#### [Minimum Data Set](docs/minimum-data-set.md)
### [Initial Operation Guide](docs/iog.md)
### [First Steps Guide](docs/iog.md)
### [Namingo EPP Server](docs/epp.md)
### [EPP Operations Guide](docs/epp.md)
### [FAQ](docs/faq.md)
### [Registrar FAQ](docs/faq.md)
### [Architecture of Namingo](docs/architecture.md)
### [System Architecture](docs/architecture.md)
## Support

View file

@ -1,4 +1,4 @@
# Namingo Registry Architecture Guide
# Namingo Registry: System Architecture
## Introduction

View file

@ -1,4 +1,4 @@
# Configuration Guide
# Namingo Registry: Configuration Guide
This document provides instructions for configuring Namingo, the domain registry management tool, after installation. It covers configuring the system, adding additional components, and customizing various configuration files for optimal setup.
@ -1905,4 +1905,4 @@ return [
In conclusion, this detailed configuration guide aims to streamline the setup process of the Namingo system for users of all expertise levels. The guide meticulously details each configuration file, providing clear explanations and guidance for customization to suit your specific needs. This approach ensures that you can configure Namingo with confidence, optimizing it for your registry management requirements. We are committed to making the configuration process as straightforward as possible, and we welcome any questions or requests for further assistance. Your successful deployment and efficient management of Namingo is our top priority.
After finalizing the configuration of Namingo, the next step is to consult the [Initial Operation Guide](iog.md). This guide provides comprehensive details on configuring your registry, adding registrars, and much more, to ensure a smooth start with your system.
After finalizing the configuration of Namingo, the next step is to consult the [First Steps Guide](iog.md). This guide provides comprehensive details on configuring your registry, adding registrars, and much more, to ensure a smooth start with your system.

View file

@ -1,4 +1,6 @@
# Guide to Adding Custom Pricing per Registrar
# Guide to Adding Custom Pricing per Registrar (Deprecated since v1.0.19)
**Since v1.0.19 this is done directly in the panel, Registrars menu**
To add custom pricing per registrar in the domain price and domain restore price tables using Adminer, follow these steps:

View file

@ -1,4 +1,4 @@
# Namingo Registry EPP Server
# Namingo Registry: EPP Operations Guide
The **Namingo EPP Server** provides a robust and standards-compliant interface for managing domain registrations, hosts, and contacts via the **Extensible Provisioning Protocol (EPP)**. This section offers practical examples of commonly used EPP commands, showcasing request and response structures for seamless integration with the Namingo Registry.

View file

@ -1,4 +1,4 @@
# Namingo FAQ
# Namingo Registry: Registrar FAQ
Welcome to the FAQ for Namingo. This document is intended as a resource for registries to share with their registrars, providing answers to common questions and guidance on managing registrar accounts.

View file

@ -1,50 +1,127 @@
# Initial Operation Guide (IOG)
# Namingo Registry: First Steps
Welcome to the Initial Operation Guide for Namingo. This document is designed to assist you in the initial setup and operation of your Namingo system. Follow these steps to ensure a smooth start and efficient management of your domain registry.
Welcome to the **First Steps Guide** for Namingo. This document will walk you through the essential steps following your Namingo installation, helping you prepare your system for production use. These steps include deleting test data, logging into the control panel, configuring your registry and TLDs, adding registrars, and validating your setup.
## Deleting Test Data
1. **Deleting Registrars and Test TLDs**: To delete test registrars and TLDs, edit the `/opt/registry/tests/clean-test-details.php` script with your database details and then execute it. It is advisable to delete test data before adding new data to the system.
## Logging into the Control Panel
1. **Access the Panel**: Begin by logging in to the control panel as the registry administrator. This is the user account you created during the installation process.
2. **Familiarize Yourself**: Once logged in, take some time to explore the interface and familiarize yourself with the various features and settings available.
## Configuring Your Registry
1. **Navigate to Registry Configuration**: In the control panel, go to the `registry-configuration` menu.
2. **Set Up Registry Details**: Here, you will configure essential details such as:
- **Registry Operator Name**: The official name of your registry.
- **Registry Handle**: A unique identifier for your registry.
- **WHOIS/RDAP Server URLs**: The URLs for your WHOIS and RDAP servers.
- **Registry VAT/Company Number**: Your registry's tax or company identification number.
- **Registry Contact Information**: Address, email, and phone number for registry contact.
- **Launch Phase Extension**: Decide whether to enable the launch phase extension feature.
## Adding Top-Level Domains (TLDs)
1. **Go to Registry TLDs Menu**: In the control panel, select the `registry-TLDs` menu.
2. **Add Your TLD**: You can add a new TLD by specifying details such as:
- **Extension**: The TLD extension (e.g., .com, .org).
- **Type**: Whether it's a ccTLD or gTLD.
- **Supported Script**: The script types supported by the TLD.
- **Pricing**: Set prices for registration and renewal.
- **Premium Names**: Define any premium domain names.
3. **Manage Reserved Names**: In this section, you can also manage names that are reserved and not available for general registration.
4. **Update Configuration Files**: Edit `/opt/registry/epp/config.php` and `/var/www/cp/.env` to set the `test_tlds` variables to your TLD(s).
## Managing Registrars
1. **Create a Registrar**: Navigate to the **Registrars** section, select **Create Registrar** from the menu, and fill in the required details to add your first registrar to the system.
## Testing Your Registry Setup
1. **Create a Contact**: Begin by creating a contact in the system. This contact will be used in the domain registration process.
2. **Register a Domain**: Use the contact you created to register a domain under one of your TLDs. This step will help you experience the end-to-end process of domain registration just as your registrars would.
3. **Verify with WHOIS and RDAP**: After registering the domain, utilize the WHOIS and RDAP services to verify that the domain has been successfully added to the system.
4. **Validate the Setup**: Completing this process not only familiarizes you with the platforms functionality but also serves as a validation to ensure all components of your registry are functioning as expected. This step is crucial in preparing for managing live domain registrations.
> **Before You Begin**: Ensure youve completed the [Configuration Guide](configuration.md) and can access the admin control panel.
---
Upon completing the steps outlined above, you are now fully equipped to manage your domain registry using Namingo. With the registry and TLD configurations set, and your first registrar added, your system is operational and ready for domain management. This marks a significant milestone in your journey with Namingo, paving the way for efficient and streamlined registry operations. Remember, the Namingo platform is designed to be intuitive and user-friendly, ensuring a smooth management experience as you grow and evolve your domain registry services.
## Step 1: Clean Up Test Data
1. **Remove Default Registrars & TLDs**
Navigate to `/opt/registry/tests/clean-test-details.php` and edit it to include your database credentials.
2. **Execute the Script**
Run the script to remove all default test registrars and TLDs:
```bash
php /opt/registry/tests/clean-test-details.php
```
> It's recommended to delete test data before adding real data to avoid conflicts or clutter.
---
## Step 2: Log into the Control Panel
1. Open the control panel in your browser.
2. Log in as the registry administrator (created during installation).
3. Explore the menus: take a moment to familiarize yourself with the interface and structure.
---
## Step 3: Configure Your Registry
1. Go to `Registry → Configuration`.
2. Fill in the following key settings:
- **Registry Operator Name**: e.g., `Namingo Ltd.`
- **Registry Handle**: Unique ID like `namingo`
- **WHOIS Server URL**: e.g., `whois.example.tld`
- **RDAP Base URL**: e.g., `https://rdap.example.tld/`
- **VAT or Company Number**
- **Contact Details**: Address, phone, email
- **Launch Phase Extension**: Enable if you plan to use Sunrise/Landrush phases
> You can return to this section anytime to update settings.
---
## Step 4: Add Top-Level Domains (TLDs)
1. Navigate to `Registry → TLDs → Create New TLD`.
2. Provide the following details:
- **TLD Extension**: (e.g., `.demo`, `.test`)
- **Supported Script**: e.g., `Latin`, `Cyrillic`
- **Pricing**: Registration, Renewal, Restore
- **Premium Names** *(optional)*: Upload or define
3. Configure per-TLD options:
- `Manage Settings`: Basic configuration
- `Manage Promotions`: Discounts or special offers
- `Manage Launch Phases`: Sunrise, Landrush, General Availability
- `Export IDN Table`: For IANA submission
4. Configure global options:
- `Reserved Names`: Manage domains that cannot be registered
- `Allocation Tokens` *(optional)*: Control access during launch phases
4. Update config files:
- `Update Configuration Files`: Edit `/opt/registry/epp/config.php` and `/var/www/cp/.env` to set the `test_tlds` variables to your TLD(s).
---
## Step 5: Add Registrars
1. Go to `Registrars → Create Registrar`.
2. Fill in the following details:
- **Registrar Name**
- **IANA ID** or internal registry identifier
- **Admin and Technical Contact Info**
- **WHOIS Server / RDAP Base URL** (if applicable)
- **Notification Emails**
3. After creation, you can:
- **Manage Registrar**: Edit status, credentials, and settings
- **Registrar Details**: View all saved information
- **Manage Custom Pricing**: Override default TLD pricing
*(Note: Manual config required before version 1.0.19 — see [custom-registrar-pricing.md](docs/custom-registrar-pricing.md))*
- **Impersonate**: Log in as the registrar for testing purposes
> Use impersonation only for internal testing or support all actions are logged.
---
## Step 6: Test the System
Validate that everything works as expected before going live:
1. **Create a Contact**
Navigate to `Contacts → Create Contact` and enter sample registrant information.
2. **Register a Domain**
Go to `Domains → Create Domain`, select a TLD, and use your contact.
3. **Check WHOIS and RDAP**
Use terminal or online tools to confirm the domain is live:
```bash
whois example.demo
curl https://rdap.example.tld/domain/example.demo
```
> **This is your end-to-end test**:
> If registration works and the domain data is visible via WHOIS and RDAP, your registry setup is fully functional and ready for production use.
---
## You're Ready to Go
With your registry now configured, at least one TLD active, and registrars added, your Namingo system is operational and production-ready.
Youve completed the essential First Steps. From here, you can:
- Start onboarding registrars
- Launch TLDs with phased rollout (Sunrise, Landrush, General)
- Enable premium/reserved domain policies
Welcome to Namingo — the open, flexible registry platform for your domain ambitions!