diff --git a/README.md b/README.md new file mode 100644 index 0000000..fe84db7 --- /dev/null +++ b/README.md @@ -0,0 +1,96 @@ +

+

Free Domains

+ +

+ + + +

+ +

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

+ +## Domains + +| Domains | +|:-:| +| [`is-a-backend.dev`](https://is-a-backend.dev) | +| [`is-a-frontend.dev`](https://is-a-frontend.dev) | + +#### Unsupported Services + +- Netlify +- Vercel + +### Settings + +> All domains use the same settings. + +| Setting | Option | +|-----------------------------------------------------|-----------------------| +| [DNSSEC][dnssec] | ✅ | +| Email | ❌ | +| SSL/TLS* | [Full][ssl-full] | +| Always Use HTTPS* | ✅ | +| HTTP Strict Transport Security (HSTS) | ✅ | +| Minimum TLS Version* | 1.0 | +| Opportunistic Encryption, TLS 1.3* | ✅ | +| WAF (Web Application Firewall)* | Medium Security Level | +| Browser Integrity Check* | ✅ | +| [Caching Level][caching-levels], Browser Cache TTL* | Standard, 4 hours | + +###### \*Only available when your domain has `proxied` mode set to `true`. + +[dnssec]:https://developers.cloudflare.com/dns/additional-options/dnssec +[ssl-full]:https://developers.cloudflare.com/ssl/origin-configuration/ssl-modes/full/ +[caching-levels]:https://developers.cloudflare.com/cache/how-to/set-caching-levels +[crawler-hints]:https://blog.cloudflare.com/crawler-hints-how-cloudflare-is-reducing-the-environmental-impact-of-web-searches/ +[http2]:https://www.cloudflare.com/website-optimization/http2/what-is-http2/ +[http2-to-origin]:https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin +[0rtt]:https://developers.cloudflare.com/fundamentals/network/0-rtt-connection-resumption/ +[grpc]:https://support.cloudflare.com/hc/en-us/articles/360050483011 +[pseudo-ipv4]:https://support.cloudflare.com/hc/en-us/articles/229666767 + +## Register a Domain + +1. **Star** and **[Fork](https://github.com/free-domains/register/fork)** this repository +2. Add a new file called `example.domain.com.json` in the `/domains` folder to register the `example` subdomain on the `domain.com`. + - An list of available domains can be found [here](#domains). +3. Edit it to meet your needs. + - The file listed below is just an **example**, provide a **valid** JSON file with your needs. + - Make sure to remove any records that aren't needed. + +```json +{ + "$schema": "../schemas/domain.json", + + "domain": "is-a-frontend.dev", + "subdomain": "example", + + "owner": { + "email": "hello@example.com" + }, + + "record": { + "A": ["1.1.1.1", "1.0.0.1"], + "AAAA": ["::1", "::2"], + "CNAME": "example.com.", + "TXT": ["example_verification=1234567890"] + }, + + "proxied": false +} +``` + +4. Your pull request will be reviewed and merged. + - **Do not** ignore the pull request checklist, this is _required_. + - Make sure to keep an eye on your pull request 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 _(in most cases it takes up to 5 minutes)_ +6. Enjoy your new domain! + +> Domains used for illegal purposes or being abused will be removed and permanently banned without notice. + +> NSFW content is not allowed. + +### License + +This project is under a [MIT License](https://github.com/free-domains/register/blob/main/LICENSE).