certs | ||
http | ||
utils | ||
xip | ||
.dockerignore | ||
.gitignore | ||
compose.yml | ||
Dockerfile | ||
fly.toml | ||
go.mod | ||
go.sum | ||
LICENSE | ||
main.go | ||
README.md |
local-ip.sh
local-ip.sh is a magic domain name that provides wildcard DNS for any IP address. It is heavily inspired by local-ip.co, sslip.io, and xip.io
Usage
go run ./main.go # binds to :53 by default but you can override it by using the `-port` parameter
dig @localhost 10-0-1-29.my.local-ip.sh +short
# 10.0.1.29
dig @localhost app.10-0-1-29.my.local-ip.sh +short
# 10.0.1.29
dig @localhost foo.bar.10.0.1.29.my.local-ip.sh +short
# 10.0.1.29
dig @localhost 127.0.0.1.my.local-ip.sh +short
# 127.0.0.1
How it works
local-ip.sh packs up:
- an authoritative DNS server that answers queries for the zone
local-ip.sh
- a Let's Encrypt client that takes care of obtaining and renewing the wildcard certificate for
*.local-ip.sh
and the root certificate forlocal-ip.sh
using the DNS-01 challenge - an HTTP server that serves static files, including the certificate files
It answers queries with the IPv4 address it may find in the subdomain by pattern matching the FQDN.
It registers an account to Let's Encrypt's ACME server to obtain the wildcard certificate on the first run and then renew
it about a month before it expires. The account file and the associated key used to request a certificate under the ./.lego/accounts
directory and the certificate's files are stored in ./.lego/certs
.
The certificate files are served by an HTTP server on the arbitrary port :9229
that is intentionally not exposed to
the internet. The website is connected to the same private network as the service and serves
as a proxy to access the files securely.
Self-hosting
I'm currently hosting local-ip.sh at Fly.io but you can host the service yourself if you're into that kind of thing. Note that you will need to edit your domain's glue records so make sure your registrar allows it.
You will essentially need to:
- replace any occurrence of
local-ip.sh
in.go
files with your domain - replace the hardcoded IP addresses in the
hardcodedRecords
map declared inxip.go:37
, the important records to keep are:A ns.local-ip.sh.
holds both IP addresses pointing tons1.
andns2.
A ns1.local-ip.sh.
holds the first IP address pointing to the server hosting local-ip.shA ns2.local-ip.sh.
holds the second IP address pointing to the server, exists for redundancyTXT _acme-challenge.local-ip.sh.
will temporarily hold the value to solve the DNS-01 challenge
- set your domain's glue records to point to the IP addresses you set for
ns1.
andns2.
- retrieve the certificate files once the program is up and running