Updates content.

This commit is contained in:
Pierre Lannoy 2023-12-21 10:17:40 +01:00
commit f89c1b83f2
Signed by: Pierre Lannoy
GPG key ID: D27231EF87D53F31
2 changed files with 20 additions and 65 deletions

View file

@ -3,6 +3,8 @@ All notable changes to **Domain-Forward** are documented in this *changelog*.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and **Domain-Forward** adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [1.0.0] - 2023-12-12
## [1.0.0] - 2023-12-21
First release, supporting DoH resolution.
Initial commit from fork: https://github.com/willnode/forward-domain

View file

@ -1,99 +1,52 @@
# Forward Domain
# Domain Forward
This service forwards domains using HTTP(s) redirects.
The service to forward domains using HTTP(s) redirects via Hosterra DoH.
ATTENTION: THIS SERVICE IS NOT PUBLICLY AVAILABLE FOR NOW. EXPECT IT FOR SECOND WEEK OF 2024.
Example scenarios:
+ Forward non-www to www domains or vice versa
+ Forward old domains to new domains
Why using this service?
+ No coding required
+ No hosting required
+ No registration required
+ Completely anonymous
+ Completely free
How does it works?
+ Point your domain to us using CNAME or A/AAAA records
+ Point your domain to Hosterra using CNAME or A/AAAA records
+ Tell us where to forward using TXT records
+ We handle HTTPS certificates for you
+ We handle redirection and HTTPS certificates for you
## Get Started
To forward from `www.old.com` to `old.com`, add these records to your DNS:
```
www.old.com IN CNAME r.forwarddomain.net
_.www.old.com IN TXT forward-domain=https://old.com/*
www.old.com IN CNAME fwd.hosterra.tech
_forward.www.old.com IN TXT forward-to=https://old.com/*
```
Because CNAME can't be used in apex domains, you can use A/AAAA records.<br>
Because CNAME can't be used in apex domains, you can use A/AAAA records.
To forward from `old.com` to `new.net`, add these records to your DNS:
```
old.com IN A 167.172.5.31
_.old.com IN TXT forward-domain=https://new.net/*
old.com IN A 51.159.188.120
old.com IN AAAA 2001:bc8:1210:656:dc00:ff:fe26:bfdd
_forward.old.com IN TXT forward-to=https://new.net/*
```
The star `*` at the end tells us that the remaining URL path is also forwarded to the destination URL.
> If you use Cloudflare or any DNS which supports [CNAME Flattening](https://blog.cloudflare.com/introducing-cname-flattening-rfc-compliant-cnames-at-a-domains-root/), you still can use CNAME records pointing to `r.forwarddomain.net`. It's recommended to use CNAME records rather than A/AAAA records.
> If you use Cloudflare or any DNS which supports [CNAME Flattening](https://blog.cloudflare.com/introducing-cname-flattening-rfc-compliant-cnames-at-a-domains-root/), you still can use CNAME records pointing to `fwd.hosterra.tech`. It's recommended to use CNAME records rather than A/AAAA records.
You can choose the type of redirection you want to use by declaring the `http-status` value:
```
www.old.com IN CNAME r.forwarddomain.net
_.www.old.com IN TXT http-status=302;forward-domain=https://old.com/*
www.old.com IN CNAME fwd.hosterra.tech
_forward.www.old.com IN TXT http-status=302;forward-to=https://old.com/*
```
> Only the HTTP status code 301 and 302 are supported. By default it's 301, which is permanent redirection. Set to 302 if you want temporary redirection, it has effect on search engine indexing.
> HTTP status codes 301, 302, 303, 307 and 308 are supported. By default it's 301, which is permanent redirection.
## FAQ
### Is it really free?
Forwarding domains should be easy to setup.<br>
I use this myself for [domcloud.io](https://domcloud.io).<br>
### How can I check redirects will work?
This service uses Google's [Public DNS Resolver](https://dns.google).<br>
Once first accessed, values will be cached for a day.<br>
For right now there's no way to flush the cache sorry.
### Why it loads slowly?
It only slow at first time because it has to sign HTTPS certificates.
### How about IPv6?
IPv6 record is added in `r.forwarddomain.net` so subdomain redirects will simply work with IPv6. We don't guarantee that its IPv6 address will be persistent though. See [#2](https://github.com/willnode/forward-domain/issues/2#issuecomment-1003831835) for apex domains setup.
### What records do we keep?
We only keep caches of DNS records and SSL certs. This also means we can see how many users and what domains are using our service from the software cache, but that's all. We don't keep log traffic nor keep any user data anywhere on our server.
### How can I support this service?
Star our repo and spread the word, please :)
Additionally, you can also help us [cover hosting costs](https://github.com/sponsors/willnode).
## Credits
Things in `package.json`. I also borrow code from [zbo14/certnode](https://github.com/zbo14/certnode).
## Usual Disclaimer
```
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
This software is based on the invaluable work of [Wildan M](https://github.com/willnode/forward-domain) and [BYU Internet Measurement and Anti-Abuse Lab](https://github.com/byu-imaal/dohjs). Endless thanks to them and all the contributors to these two projects.