From 88e2750ed0831243b3491bdbc7b97c4e5802fe0d Mon Sep 17 00:00:00 2001 From: andrewstech Date: Tue, 22 Jul 2025 21:02:03 +0100 Subject: [PATCH] Update README.md --- README.md | 142 ++++++++++++++++++++++++------------------------------ 1 file changed, 63 insertions(+), 79 deletions(-) diff --git a/README.md b/README.md index 3cc48efd..7aba7e24 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,28 @@ -

- Open Domains Logo -

- +

Open Domains

- - Domain Count - - - Open Issues - - - Open Pull Requests - + + +

-

Free subdomains for personal sites, open-source projects, and more.

-

Want to find similar services? Check out Free For Life.

+

Free subdomains for personal sites, open-source projects, and more.

+

Want to find services similar to this? Take a look on Free For Life.

---- +## Notice +NS records are available for donators only. You can donate at: https://donate.stripe.com/cN2eYpaDl4NR21qaEE -## 💸 Donate +## Donate +If you like this service and want us to continue running it, please consider donating! -If you like this service and want it to keep running, please consider donating! +[![PayPal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://donate.stripe.com/cN2eYpaDl4NR21qaEE) -[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://donate.stripe.com/cN2eYpaDl4NR21qaEE) +### Discord Server +Make sure to join our Discord server: +https://discord.gg/kVjkg6VBwa -> **Note:** NS records are available for donators only. - ---- - -## 💬 Join Our Community - -Come hang out on our Discord: [https://discord.gg/kVjkg6VBwa](https://discord.gg/kVjkg6VBwa) - ---- - -## 🌍 Available Domains +## 🌍 Available Domains | Available Domains | |:-:| @@ -48,27 +33,30 @@ Come hang out on our Discord: [https://discord.gg/kVjkg6VBwa](https://discord.gg | [`*.localplayer.dev`](https://localplayer.dev) | | [`*.open-comm.org`](https://open-comm.org) | -> [!NOTE] -> Wildcard domains (like `*.example.is-not-a.dev`) are supported too, but the reason for their registration should be very clear and described in detail. -> + > **Note:** `open-comm.org` is not currently listed on the [Public Suffix List (PSL)](https://publicsuffix.org/). ---- +> [!NOTE] +> Wildcard domains (like `*.example.is-not-a.dev`) are supported too, but the reason for their registration should be very clear and described in detail. -### ⚙️ Settings +[badge-cf]:https://shields.io/badge/%20-cloudflare-blue?logo=cloudflare&style=plastic?cacheSeconds=3600 +[badge-dnssec]:https://shields.io/badge/%20-DNSSEC-blue?logo=moleculer&logoColor=white&style=plastic?cacheSeconds=3600 +[badge-ssl]:https://shields.io/badge/SSL-Required-blue?style=plastic?cacheSeconds=3600 + +### ⚙️ Settings | Setting | [`is-a-fullstack.dev`](https://is-a-fullstack.dev) | [`is-cool.dev`](https://is-cool.dev) | [`is-local.org`](https://is-local.org) | [`is-not-a.dev`](https://is-not-a.dev) | [`localplayer.dev`](https://localplayer.dev) | [`open-comm.org`](https://open-comm.org) | |-|-|-|-|-|-|-| -| PSL | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | -| [DNSSEC][dnssec] | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| Email | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| PSL | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | +| [DNSSEC][dnssec] | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| Email | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | SSL/TLS* | [Full][ssl-full] | [Full][ssl-full] | [Full][ssl-full] | [Full][ssl-full] | [Full][ssl-full] | [Full][ssl-full] | -| Always Use HTTPS* | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| HTTP Strict Transport Security (HSTS) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| Always Use HTTPS* | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| HTTP Strict Transport Security (HSTS) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | Minimum TLS Version* | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | 1.2 | -| Opportunistic Encryption, TLS 1.3* | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| Opportunistic Encryption, TLS 1.3* | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | WAF (Web Application Firewall)* | Medium Security Level | Medium Security Level | Medium Security Level | Medium Security Level | Medium Security Level | Medium Security Level | -| Browser Integrity Check* | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| Browser Integrity Check* | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | [Caching Level][caching-levels], Browser Cache TTL* | Standard, 4 hours | Standard, 4 hours | Standard, 4 hours | Standard, 4 hours | Standard, 4 hours | Standard, 4 hours | \*Only available when your domain has Cloudflare's proxy (`"proxied": true`) enabled @@ -79,54 +67,50 @@ Come hang out on our Discord: [https://discord.gg/kVjkg6VBwa](https://discord.gg --- -## 📝 Register - -### Manual Registration +## Register +### Manual 1. **Star** and **[Fork](https://github.com/open-domains/register/fork)** this repository. 2. Add a new file called `example.domain.json` in the `/domains` folder to register `example` subdomain. -3. Edit the file (below is just an **example**, provide a **valid** JSON file with your needs): +3. Edit the file (below is just an **example**, provide a **valid** JSON file with your needs, the format is very strict. These records should not show up inside your file. ```json { - "description": "Project Description", - "domain": "is-not-a.dev", - "subdomain": "example", + "description": "Project Description", + "domain": "is-not-a.dev", + "subdomain": "example", - "owner": { - "repo": "https://github.com/username/repo", - "email": "hello@example.com" - }, + "owner": { + "repo": "https://github.com/username/repo", + "email": "hello@example.com" + }, - "record": { - "A": ["1.1.1.1", "1.0.0.1"], - "AAAA": ["::1", "::2"], - "CNAME": "example.com", - "MX": ["mx1.example.com", "mx2.example.com"], - "TXT": ["example_verification=1234567890"], - "CAA": [ - { "flags": 0, "tag": "issue", "value": "letsencrypt.org" }, - { "flags": 0, "tag": "issuewild", "value": "sectigo.com" } - ], - "SRV": [ - { "priority": 10, "weight": 60, "port": 5060, "target": "sipserver.example.com" }, - { "priority": 20, "weight": 10, "port": 5061, "target": "sipbackup.example.com" } - ] - }, + "record": { + "A": ["1.1.1.1", "1.0.0.1"], + "AAAA": ["::1", "::2"], + "CNAME": "example.com", + "MX": ["mx1.example.com", "mx2.example.com"], + "TXT": ["example_verification=1234567890"], + "CAA": [ + { "flags": 0, "tag": "issue", "value": "letsencrypt.org" }, + { "flags": 0, "tag": "issuewild", "value": "sectigo.com" } + ], + "SRV": [ + { "priority": 10, "weight": 60, "port": 5060, "target": "sipserver.example.com" }, + { "priority": 20, "weight": 10, "port": 5061, "target": "sipbackup.example.com" } + ] + }, - "proxied": false + "proxied": false } + ``` -4. Create a pull request with the file you added. -5. **Watch your PR** – if you ignore required changes, it will be ignored too. -6. Once merged, please allow up to 24 hours for changes to propagate _(usually it takes just 5–15 minutes)_. -7. Enjoy your new domain! +4. Your pull request will be reviewed and merged. Please don't ignore the pull request checklist. If you ignore the checklist, your pull request will be ignored too. _Make sure to keep an eye on it in case we need you to make any changes!_ +5. After the pull request is merged, please allow up to 24 hours for the changes to propagate _(usually, it takes 5..15 minutes)_ +6. Enjoy your new domain! -> ⚠️ Domains used for illegal or malicious purposes will be removed and banned permanently. +*Domains used for illegal purposes will be removed and permanently banned. Please, provide a clear description of your resource in the pull request.* ---- - -## ⚖️ License - -This project is licensed under the [MIT License](https://github.com/open-domains/register/blob/main/LICENSE). +### License +This project is under a [MIT License](https://github.com/open-domains/register/blob/main/LICENSE).