mirror of
https://github.com/tiennm99/open-domains.git
synced 2026-10-11 03:13:41 +00:00
Update README.md
This commit is contained in:
andrewstech authored and GitHub committed
1 parent
df28f0e435
commit
88e2750ed0
1 file changed
+63
-79
@@ -1,43 +1,28 @@
|
||||
<p align="center">
|
||||
<img src="https://raw.githubusercontent.com/open-domains/register/main/media/icon.png" height="128" alt="Open Domains Logo">
|
||||
</p>
|
||||
|
||||
<p align="center"><img src="https://raw.githubusercontent.com/open-domains/register/main/media/icon.png" height="128"></p>
|
||||
<h1 align="center">Open Domains</h1>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/open-domains/register/tree/main/domains">
|
||||
<img src="https://img.shields.io/github/directory-file-count/open-domains/register/domains?label=domains&style=for-the-badge&type=file" alt="Domain Count">
|
||||
</a>
|
||||
<a href="https://github.com/open-domains/register/issues">
|
||||
<img src="https://img.shields.io/github/issues-raw/open-domains/register?label=issues&style=for-the-badge" alt="Open Issues">
|
||||
</a>
|
||||
<a href="https://github.com/open-domains/register/pulls">
|
||||
<img src="https://img.shields.io/github/issues-pr-raw/open-domains/register?label=pull%20requests&style=for-the-badge" alt="Open Pull Requests">
|
||||
</a>
|
||||
<a href="https://github.com/open-domains/register/tree/main/domains"><img src="https://img.shields.io/github/directory-file-count/open-domains/register/domains?label=domains&style=for-the-badge&type=file"></a>
|
||||
<a href="https://github.com/open-domains/register/issues"><img src="https://img.shields.io/github/issues-raw/open-domains/register?label=issues&style=for-the-badge"></a>
|
||||
<a href="https://github.com/open-domains/register/pulls"><img src="https://img.shields.io/github/issues-pr-raw/open-domains/register?label=pull%20requests&style=for-the-badge"></a>
|
||||
</p>
|
||||
|
||||
<p align="center"><strong>Free subdomains for personal sites, open-source projects, and more.</strong></p>
|
||||
<p align="center">Want to find similar services? Check out <a href="https://free.hrsn.dev/#/?id=domains">Free For Life</a>.</p>
|
||||
<p align="center">Free subdomains for personal sites, open-source projects, and more.</p>
|
||||
<p align="center">Want to find services similar to this? Take a look on <a href="https://free.hrsn.dev/#/?id=domains">Free For Life</a>.</p>
|
||||
|
||||
---
|
||||
## 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!
|
||||
[](https://donate.stripe.com/cN2eYpaDl4NR21qaEE)
|
||||
|
||||
[](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).
|
||||
Reference in new issue
Block a user