Chauffeur requires two operating-system-level configuration changes in order to function. The exact instructions for these changes will vary by operating system type, distribution, and configuration, and involve injecting configuration into system services which control how your computer resolves internet links and how it determines which SSL certificates are valid.
As such, you are strongly recommended to understand these changes before implementing them, and are advised that these changes may result in instability or insecurity if done incorrectly.
The first change to make is to configure resolution of the eth.local
domain namespace.
Create the file /etc/systemd/resolved.conf.d/chauffeur.conf
, with the following content:
[Resolve]
DNS=172.28.0.1
Domains=~eth.local
Then, execute systemctl restart systemd-resolved.service
.
After starting Chauffeur as indicated in the Startup section, a directory path will be created in the root
of this repository named certificates/pki/authorities/chauffeur
. Within this directory will be a file named root.crt
,
which is an SSL Root Certificate from which individual certificates
will be generated for ENS subdomains (e.g. vitalik.eth.local
).
This root certificate needs to be added to your local trust store in order for the certificates issued by Chauffeur to be regarded as valid by your browser or other applications.
Most Linux distributions have a utility simply named trust
available, which will
add a specified certificate to the system's trust policy store.
To do this, run trust anchor certificates/pki/authorities/chauffeur/root.crt
.
- Optionally copy
.env.dist
to.env
, and populate any of the specified environment variables according to your needs
To start Chauffeur, simply run docker-compose up
in the root of this repository.
Optionally, specify --profile trustless
in order to launch the Geth light client service for RPC.
You can also see the complete [list of contributors][contributors] who participated in this project.
Chauffeur
is open source software [licensed as MIT][license].