Documentation improvements

README.md

@@ -14,7 +14,33 @@ Namingo is optimally designed for the upcoming ICANN application round, providin
 
 ## Get Involved
 
-**Namingo** version 1.0.0 is now complete, thanks to our dedicated community. However, the journey doesn't end here! We are seeking volunteers to help test Namingo, which currently manages 150,000 domains on a VPS setup (2 cores, 4GB RAM, 100GB SSD) and is compatible with Ubuntu 22.04/24.04 LTS and Debian 12, supporting MariaDB/MySQL databases. We also need testers for new OS and database setups, including AlmaLinux, Alpine Linux, FreeBSD 14, and Windows, with both MariaDB/MySQL and PostgreSQL options. Additionally, we seek assistance from gTLD operators to help us test Namingo by providing access to ICANN and other relevant systems. Your contributions are invaluable in refining and expanding Namingo's capabilities. Join us in ensuring Namingo remains the best in its class.
+**Namingo** version 1.0.0 is now complete, thanks to our dedicated community. The journey doesn't end here, and we invite volunteers to help us continue testing and improving Namingo.
+
+Currently, Namingo is able to manage 150,000 domains on a VPS setup featuring 2 cores, 4GB RAM, and a 100GB SSD. It is compatible with Ubuntu 22.04/24.04 LTS and Debian 12, supporting MariaDB/MySQL databases. We are also seeking testers for new operating systems and database setups, including AlmaLinux, Alpine Linux, FreeBSD 14, and Windows, with both MariaDB/MySQL and PostgreSQL options.
+
+Additionally, we are looking for assistance from gTLD operators to test Namingo by providing access to ICANN and other relevant systems. Your contributions are invaluable in refining and expanding Namingo's capabilities. Join us in ensuring Namingo remains the best in its class.
+
+### Benchmark Summary (per registrar)
+
+- VPS Setup: 2 virtual CPU cores (AMD EPYC-Rome, 2 GHz), 2 GB RAM, SSD drive, Ubuntu 22.04
+
+#### Domain Checks:
+
+- Operations per Second: 217.55
+
+- Average Time per Operation: 4.596 ms
+
+#### Domain Info Queries:
+
+- Operations per Second: 94.65
+
+- Average Time per Operation: 10.57 ms
+
+#### Domain Creations:
+
+- Operations per Second: 42.17
+
+- Average Time per Operation: 23.72 ms
 
 ## Features
 
@@ -48,13 +74,15 @@ Namingo is equipped with a comprehensive suite of features to meet the diverse n
 
 ## Documentation
 
-We invite you to thoroughly review all the `.md` files within the `docs` directory to familiarize yourself with the various aspects of Namingo. These documents provide comprehensive guidance on installation, configuration, and initial operation, ensuring you have all the information you need to successfully manage your domain registry.
+Our documentation provides comprehensive guidance on installation, configuration, and initial operation, ensuring you have all the information you need to successfully manage your domain registry.
 
-### Installation Instructions
+### Installation and Upgrade Instructions
 
 #### Automated Install
 
-For a quick and easy installation, you can use the automated install script by running the following command:
+To begin, simply copy the command below and paste it into your server terminal. This installation process is optimized for a fresh VPS running Ubuntu 22.04/24.04 or Debian 12.
+
+**Minimum requirement:** a VPS with at least 1 CPU core, 2 GB RAM, and 10 GB hard drive space. Please use MySQL or MariaDB.
 
 ```bash
 wget https://namingo.org/install.sh -O install.sh && chmod +x install.sh && ./install.sh
@@ -62,10 +90,38 @@ wget https://namingo.org/install.sh -O install.sh && chmod +x install.sh && ./in
 
 This command will download and execute the `install.sh` script from Namingo's website, which automates the installation process.
 
+*IPv6 Requirement:* If your system lacks IPv6 support, test with `ping -6 ipv6.google.com`. To prevent installer issues, edit `/etc/gai.conf` and uncomment or add the following line
+
+```bash
+precedence ::ffff:0:0/96 100
+```
+
+In the `config.php` files of WHOIS/DAS components make sure you replace `::` with `false` or for EPP - with `0.0.0.0`
+
 #### Manual Installation Steps
 
 For detailed installation steps, please refer to [install.md](docs/install.md).
 
+#### Upgrade Steps (from v1.0.0-RC4 or later)
+
+For detailed upgrade steps, please refer to [upgrade.md](docs/upgrade.md).
+
+### [Configuration Guide](docs/configuration.md)
+
+#### [Database Replication](docs/replication.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)
+
+### [FAQ](docs/faq.md)
+
+### [Architecture of Namingo](docs/architecture.md)
+
 ## Support
 
 Your feedback and inquiries are invaluable to Namingo's evolutionary journey. If you need support, have questions, or want to contribute your thoughts:

docs/configuration.md

@@ -291,4 +291,4 @@ location /dbtool.php {
 
 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](docs/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 [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.

docs/custom-registrar-pricing.md

@@ -0,0 +1,48 @@
+# Guide to Adding Custom Pricing per Registrar
+
+To add custom pricing per registrar in the domain price and domain restore price tables using Adminer, follow these steps:
+
+## 1. Access Adminer:
+
+Log in to your Adminer interface with your database credentials.
+
+## 2. Navigate to the Correct Table:
+
+- For general pricing, select the `domain_price` table.
+- For restoration pricing, select `the domain_restore_price` table.
+
+## 3. Add a New Row:
+
+Click on the "Insert" tab at the top of the page to add a new record.
+
+## 4. Fill in the Details:
+
+- tldid: Enter the ID corresponding to the TLD (Top-Level Domain) you want to set the price for.
+
+- registrar_id: Enter the ID of the registrar for whom you are setting the custom pricing. This field is crucial for setting registrar-specific pricing.
+
+- command (only in the domain price table): Select the operation you are pricing for: 'create', 'renew', or 'transfer'.
+
+### Price Fields:
+
+For domain price:
+
+- Enter the prices for each term (e.g., m0 for 0 months, m12 for 12 months, etc.). Ensure to fill in at least the relevant fields.
+
+For domain restore price:
+
+- Enter the price in the price field.
+
+## 5. Save the Entry:
+
+Once all the necessary details are filled in, click "Save" or "Insert" at the bottom of the form.
+
+## Important Notes:
+
+- *Unique Registrar Pricing:* Ensure that you specify the registrar_id correctly to apply the custom pricing for that specific registrar. **Leaving this field NULL will cause issues with the default price.**
+
+- *Operation Specificity:* In the domain price table, the command field determines the specific operation (create, renew, transfer) the pricing applies to. Make sure to select the correct operation.
+
+- *Accuracy:* Double-check the pricing fields to ensure that they are accurately filled in, as these will directly affect billing.
+
+By following these steps, you can effectively manage custom pricing for different registrars using Adminer.

docs/minimum-data-set.md

@@ -1,4 +1,4 @@
-# Minimal Data Set Documentation	
+# Minimum Data Set Documentation	
 
 This document provides guidance on transitioning to the Minimum Data Set for domain registration data. This change requires registries to update their systems to stop accepting specific contact data for domain names. The purpose of this document is to provide an overview of the Minimum Data Set, how to activate it in your configuration files, and the implications of this change.
 

docs/upgrade.md

@@ -1,4 +1,4 @@
-# Namingo Upgrade Guide (from v1.0.0-RC4 or v1.0.0-RC5)
+# Namingo Upgrade Guide (from v1.0.0-RC4 or later)
 
 ## Introduction
 
@@ -111,7 +111,8 @@ ZONE_MODE=nice // or default based on your requirement
 
 ```bash
 cp -r /opt/upgrade/* /opt/registry/
-cp -r /opt/upgrade/web/* /var/www/
+cp -r /opt/upgrade/cp/* /var/www/
+cp -r /opt/upgrade/whois/* /var/www/
 ```
 
 ## Step 6: Delete Panel Cache and Update Composer
@@ -122,7 +123,16 @@ cp -r /opt/upgrade/web/* /var/www/
 find /var/www/cp/cache/* -type d -exec rm -rf {} +
 ```
 
-2. Run `composer update` in each component directory.
+2. Run `composer update` in each component directory:
+
+```bash
+/opt/registry/epp
+/opt/registry/das
+/opt/registry/rdap
+/opt/registry/whois/port43
+/var/www/cp
+/var/www/whois
+```
 
 ## Step 7: Restart Services