Config file

Here's a fully annotated config file:

# [optional] path to file for storing information that's persisted across reboots of `earendil` daemon (e.g., the global relay graph and chat history). This must be a path writable by the `earendil` daemon. Storing this information may speed up initial connection times. 
db_path: ./.cache/earendil

# [include for relays, omit for clients] path to file for storing a long-term identity.
identity_file: /your/path/identity.secret

# [optional] IP address where the daemon listens for control commands. If this key is not specified, then `earendil` listens for control commands on a default port. This means that if you start more than one `earendil` daemon on the same machine, you must specify this field in all but one of the daemon configs in order to prevent the additional daemons from trying to listen on the same port and crashing. 
# Currently sending control commands to remote daemons is not supported, so this should be `<free port>`.

# relays to connect to as neighbors. Client configs *must* contain at least one `out_route`; optional for relays.
    # IP address and port where the relay is listening for incoming connections
    # long-term identity of the relay
    fingerprint: 4b7a641b77c2d6ceb8b3fecec2b2978dfe81ae045ed9a25ed78b828009c4967a
    # obfuscation protocol to use, for resisting ISP-level censorship
    # There are currently 2 obfuscation options:
    # - `none`: no obfuscation. In a censored network environment, this may lead to your connection to this relay getting blocked.
    # - `sosistab3`: a TCP-based obfuscated transport with a symmetric cookie, defined by the relay. This obfuscation protocol is developed as a part of [geph5](
      sosistab3: shove-mistake-wish-endless-antique-citizen-filter-employ-cigar-clip-acid-defense
  # more relays to connect to
    connect: ...
    fingerprint: ...
    obfs: none

# starts a local Socks5 server that proxies traffic through Earendil. This gives you access to Earendil havens.
  # localhost address where the earendil Socks5 proxy listens
  # how to handle non-Earendil traffic (like a request to tunnel ``). There are 3 options:
  # 1) `pass_through`: let all non-Earendil traffic through as if you're not using Earendil. Requests to `` will behave the same way as if you weren't connected to the Earendil proxy.
  # 2) `block`: block all non-Earendil traffic. Requests to `` will fail.
  # 3) `simple_proxy`: proxy non-Earendil traffic via a specified `simple-proxy` server, similar to how you use Tor as a web proxy.
      # simple proxy server we're using
      remote: v5k6rydpg9yh9hft6c7qwz9sm3z99ytt:23456

# havens we're hosting
## a TCP haven, e.g. a website
  # path to file storing long-term haven identity. Must be writable to earendil daemon
  - identity_file: /your/path/identity.secret
    # fingerprint of relay chosen as rendezvous point for this haven (keeps haven anonymous to visitors)
    rendezvous: 4b7a641b77c2d6ceb8b3fecec2b2978dfe81ae045ed9a25ed78b828009c4967a 
      type: tcp_service
      # dock where this TCP haven is hosted
      listen_dock: 12345
      # TCP address to forward all traffic for this haven to. The TCP service behind this haven (e.g., website) should be listening to this address.

## a web proxy haven
  # path to file storing long-term haven identity. Must be writable to earendil daemon
  - identity_file: /your/path/identity.secret
     # relay chosen as our rendezvous point. Web proxy havens cannot be anonymous, so this relay should be chosen to optimize performance.
    rendezvous: 4b7a641b77c2d6ceb8b3fecec2b2978dfe81ae045ed9a25ed78b828009c4967a
        # Earendil's web proxy protocol
        type: simple_proxy 
        # dock where proxy server listens
        listen_dock: 19999

# ------------------ relay-only -------------------

# where & how to accept incoming connections
    # obfuscation protocol to use, for resisting ISP-level censorship
      sosistab3: snake-before-antenna-toward-floor-stuff-frozen-power-avocado-retire-grunt-nation
    # TCP port this in_route listens at
  # another in_route, with no obfuscation
    obfs: none

Last updated