🛠️ Step-by-Step Walkthrough

Follow these steps to claim your subdomain. Our automated Janitor will review your submission instantly!

---

🍴 1. Fork the Project

Click the Fork button at the top right of this page to create a personal copy of this repository in your GitHub account.

📂 2. Navigate to your Domain

Open the domains/ folder and enter the directory of the domain you wish to use (e.g., domains/beamgo.fyi/).

📄 3. Create your Config File

Create a new file named your-subdomain.json.

Important: Use only lowercase letters, numbers, and hyphens.

Copy and paste the following template into your file:

{
  "owner": "your-email@example.com",
  "type": "CNAME",
  "content": "yourname.github.io",
  "proxied": true
}

🚀 4. Submit your Request

1. Commit the new file to your fork.
2. Open a Pull Request from your fork to our main branch.
3. Wait for the Janitor: Our bot will audit your file. If it passes, an admin will merge it, and your site will be live within 60 seconds!

---

⚠️ Common Rejection Reasons

If your file is automatically deleted by the system, check for these issues:

• Filename: You used spaces, underscores (_), or special symbols.
• Email: The "owner" field is missing or isn't a valid email format.
• Type: You used an unsupported record type (use A, AAAA, CNAME, or TXT).
• JSON Syntax: You have a typo, such as a missing comma or quote.