Follow these simple steps to get your free subdomain.
First, fork this repository to your own GitHub account.
Navigate to the domains/ folder and create a new JSON file. The name of this file will be your subdomain.
For example: To register
example.is-a-software, you must create a file namedexample.json.
Open your new JSON file and add the required information. You must include an owner section and a record section.
owner: Your GitHub username.record: The DNS records you want. We supportA,AAAA, andCNAME.proxy(Optional): Set totrueto enable Cloudflare's proxy (orange cloud) orfalseto disable it (DNS only). Defaults tofalse.
Using a CNAME record (for services like GitHub Pages, Vercel, etc.):
{
"owner": {
"github": "your-username"
},
"record": {
"CNAME": "your-username.github.io"
},
"proxy": false
}Once you've created and saved your file, create a Pull Request from your fork back to this main repository. all checks pass,then it will be automatically merged.
Your subdomain should be live within a few minutes!
Note
Make sure to add a good commit message and a good PR title
example: Register: example.is-a.software
- ✅ Fully Automated: Just create a Pull Request, and our GitHub Actions handle the rest.
- ✅ Fast & Reliable: Your subdomain is powered by Cloudflare's robust DNS infrastructure.
- ✅ Developer-Friendly: Supports
A,AAAA, andCNAMErecords to point to any service. - ✅ Community Driven: An open-source project that you can contribute to and help improve.
The magic behind is-a.software is its fully automated, Git-based workflow. Here’s a visual representation of the process:
graph TD
A[You: Create a PR with a new domain.json file] --> B{GitHub Action: Validate PR};
B -->|Valid| C[Action: Auto-merge to main];
B -->|Invalid| D[Action: Comment on PR with error];
C --> E{GitHub Action: Sync DNS};
E --> F[Cloudflare: Create/Update DNS Record];
F --> G[Your Subdomain is Live! ✨];
This is a community project, and we welcome contributions! Whether it's improving the scripts, updating the documentation, or fixing a bug, your help is appreciated.
- Fork the repository and create a new branch.
- Make your changes.
- Open a Pull Request with a clear description of what you've done.
Join our official Discord server for support, questions, or just to chat with the community.
Licensed under the MIT License.
Don't forget to ⭐ the repository if you find it useful!