Earendil docs
English
English
  • About
  • getting started
    • Installation
    • Quick start
    • Host a web proxy
    • Visit and host havens
    • Chat
    • Run a relay
    • Pay and get paid
    • Config file
  • FAQ
    • 1+ nodes on 1 machine
  • 📖wiki
    • Type-I and II censorship resistance
    • Network architecture
    • Protocols
      • N2R (node-to-relay) protocol
      • GlobalRPC
      • Haven protocol
      • Link protocol
      • Stream protocol
      • WIP: Debt accounting
    • Onion packet format
      • Reply blocks
      • Earendil packet vs. Sphinx
    • Relay configuration
Powered by GitBook
On this page
  • Configure + start Earendil
  • Connect your browser
Edit on GitHub
  1. getting started

Quick start

Last updated 6 months ago

In this tutorial, we'll show you how to proxy web traffic through the Earendil network using the earendil GUI.

If you haven't already, install the GUI from the section.

Configure + start Earendil

All of earendil's configuration options are specified in a YAML config file, located in the "Settings" tab of the GUI.

Paste this config file into your Settings tab:

# relays to connect to
out_routes:
  # arbitrary name for this relay
  example-relay-free:
    # IP and port where the relay is listening
    connect: 62.210.93.59:12345
    # relay's long-term identity
    fingerprint: 4b7a641b77c2d6ceb8b3fecec2b2978dfe81ae045ed9a25ed78b828009c4967a
    # obfuscation protocol to use
    obfs:
      # obfuscation secret, generated and provided by the relay
      sosistab3: randomly-generated-cookie-lala-doodoo

By default, Earendil exposes a Socks5 proxy server on localhost:30003 that will proxy traffic through Earendil.

Now, start the daemon by pressing "Start" in the bottom tray. Go to the "Logs" tab, and you should see earendil's logs appearing.

You're all connected on the Earendil side!

Connect your browser

To browse the web through Earendil, we need to configure a web browser to use our Earendil SOCKS5 proxy (at localhost:30003). For Firefox this looks like:

Obtaining relay information safely

In the configuration above, we added a publicly available example relay that the Mel team maintains.

It is important to note that in production, Earendil relay information will not generally be publicly available. You will need to personally know a relay operator to obtain contact information out-of-band, through chat, email, or offline.

This is to ensure ban-resistance: if any client can just request relay information, attackers can simply join the network to get a list of relays, which can let them block or identify Earendil traffic.

image

Visit any website as you normally would, except now all your traffic is going through Earendil! You can confirm this by your IP address: you're properly connected if it's 62.210.93.59. That's the IP address of this tutorial's bootstrap node.

Now you can use Earendil as a web proxy to browse the internet anonymously! Feel free to share in our .

Thus, if you want to actually ensure ban-resistance, don't use the relay we gave you above! Instead, you can come to to ask other users for help.

checking
speed tests
Discord
our Discord
Installation
Proxying Web traffic over Earendil