Requesting a Subdomain

The Process

1. Fork the registry repository

   Visit the devspace-qzz-io/register repository on GitHub and click the "Fork" button to create your own copy.

2. Add your domain entry JSON file

   In your forked repository, create a new JSON file in the domains/ directory. The filename should match your requested subdomain (e.g., yourname.json).

3. Submit a pull request

   Commit your changes and open a pull request to the original repository. Include a brief description of your project in the PR description.

4. Wait for manual review

   Our team will review your request manually. This typically takes 1-3 business days. You may be asked for additional information or changes.

JSON Configuration Format

Your domain entry JSON file must follow this exact format:

{
  "domain": "yourname",
  "owner": {
    "github": "yourusername",
    "email": "your@email.com"
  },
  "record": {
    "type": "CNAME",
    "value": "yourusername.github.io"
  }
}

Field Descriptions

Example Configurations

GitHub Pages

{
  "domain": "johndoe",
  "owner": {
    "github": "johndoe",
    "email": "john@example.com"
  },
  "record": {
    "type": "CNAME",
    "value": "johndoe.github.io"
  }
}

Vercel

{
  "domain": "myproject",
  "owner": {
    "github": "developer",
    "email": "dev@example.com"
  },
  "record": {
    "type": "CNAME",
    "value": "cname.vercel-dns.com"
  }
}

Netlify

{
  "domain": "portfolio",
  "owner": {
    "github": "designer",
    "email": "hello@example.com"
  },
  "record": {
    "type": "CNAME",
    "value": "my-site.netlify.app"
  }
}

After Submission

Once your pull request is submitted:

• Automated checks will validate your JSON syntax
• A maintainer will review your request manually
• You may receive feedback or requests for changes
• Once approved, your subdomain will be active within 24 hours