README.md

@@ -1,5 +1,75 @@
 # Relayer for Tornado Cash [![Build Status](https://github.com/tornadocash/relayer/workflows/build/badge.svg)](https://github.com/tornadocash/relayer/actions) [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/tornadocash/relayer?logo=docker&logoColor=%23FFFFFF&sort=semver)](https://hub.docker.com/repository/docker/tornadocash/relayer)
 
+__*Tornado.cash was sanctioned by the US Treasury on 08/08/2022, this makes it illegal for US citizens to interact with Tornado.cash and all of it's mainnet contracts. Please understand the laws where you live and take all necessary steps to protect and anonomize yourself.__
+
+__*It is recommended to run your Relayer on a VPS ([Virtual Private Server](https://njal.la/)). It is also possible to run it locally with a capable computer running linux.__
+
+__*When connecting to a server you will need to use ssh. You can find information about ssh keygen and management [here](https://www.ssh.com/academy/ssh/keygen).__
+
+## Deploy with docker-compose (recommended)
+
+*Ubuntu 22.10 was used in this seutp.*
+
+*docker-compose.yml contains a stack that will automatically provision SSL certificates for your domain.*
+
+__PREREQUISITES__
+1. Install docker-compose
+  - Run `sudo curl -L https://github.com/docker/compose/releases/download/2.15.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose` with the correct [current](https://github.com/docker/compose/releases) version number after `download/`.
+  - Run `sudo chmod +x /usr/local/bin/docker-compose` to set your permissions.
+2. Install Docker
+  - Run `curl -fsSL https://get.docker.com -o get-docker.sh` to download Docker.
+  - Run `sh get-docker.sh` to install Docker.
+3. Install Git
+  - Fist run `sudo apt-get update` to make sure everything is up to date.
+  - Now run `sudo apt-get install git-all` to install Git.
+4. Install Nginx
+  - Run `sudo apt update` to make sure everything is up to date.
+  - Now run `sudo apt install nginx` to install nginx
+
+__SETUP RELAYER__
+1. Download `docker-compose.yml`, `tornado.conf`, `.env.example`, and `tornado-stream.conf`
+2. Change environment variables for `mainnet` containers in `docker-compose.yml` as needed.
+  - Add `PRIVATE_KEY` for your relayer address (remove the 0x from your private key)
+  - Set `VIRTUAL_HOST` and `LETSENCRYPT_HOST` to your domain name and add a DNS record pointing to your relayer ip address
+  - Set `RELAYER_FEE` to what you would like to charge as your fee (remember .3% is paid to the DAO)
+  - Set `RPC_URL` and `ORACLE_RPC_URL` to a non-censoring RPC (You can [run your own](https://github.com/feshchenkod/rpc-nodes), or use a [free option](https://chainnodes.org/))
+  - update `REDIS_URL` if needed
+
+__SETUP NGINX REVERSE PROXY__
+1. Open your terminal, navigate to the directory containing `docker-compose.yml` and run `docker-compose up -d`
+2. Let `docker-compose up -d` run and and wait for the certbot certificates for your domain (this should take 1-2 minutes)
+3. Make sure UFW is installed by running `apt update` and `apt install ufw` 
+4. Allow SSH in the first position in UFW by running `ufw insert 1 allow ssh`
+5. Allow HTTP, and HTTPS by running `ufw allow https/tcp/http`
+6. Create the file `/etc/nginx/conf.d/tornado.conf` with the `tornado.conf` file as the contents
+7. Edit your `/etc/ngninx/nginx.conf` and append the file with the following:
+  - ` stream {  map_hash_bucket_size 128;  map_hash_max_size 128;  include /etc/nginx/conf.d/streams/*.conf;  }`
+  - Some of the contents of stream might already be there. The most important part is `include /etc/nginx/conf.d/streams/*.conf;`
+8. Create `/etc/nginx/conf.d/streams/tornado-stream.conf`with the `tornado-stream.conf` file as the contents
+9. Run `sudo service nginx restart`
+
+__Deploy on side chains__
+1. Download `docker-compose.yml`,  `.env.example` Edit the names of these files as needed.
+2. Change environment variables for containers in `docker-compose.yml` as needed.
+- Change `mainnet` to match the name of the chain you are deploying on.
+- Set the `NET_ID` to the chain ID of the chain you are deploying to. (e.g. goerli = 5)
+- Add `PRIVATE_KEY` for your relayer address (remove the 0x from your private key)
+- Set `VIRTUAL_HOST` and `LETSENCRYPT_HOST` to your domain name and add a DNS record pointing to your relayer ip address
+- Set `RELAYER_FEE` to what you would like to charge as your fee (remember .3% is paid to the DAO)
+- Set `RPC_URL` to a non-censoring RPC (You can [run your own](https://github.com/feshchenkod/rpc-nodes), or use a [free option](https://chainnodes.org/))
+- You will need to set the `ORACLE_RPC_URL` to a mainnet RPC.
+- update `REDIS_URL` if needed
+
+## Run as a Docker container
+
+1. `cp .env.example .env`
+2. Modify `.env` as needed
+3. `docker run -d --env-file .env -p 80:8000 tornadocash/relayer`
+
+In that case you will need to add https termination yourself because browsers with default settings will prevent https
+tornado.cash UI from submitting your request over http connection
+
+
 ## Run locally
 
 1. `npm i`
@@ -17,28 +87,6 @@ Relayer should return a transaction hash.
 
 _Note._ If you want to change contracts' addresses go to [config.js](./config.js) file.
 
-## Deploy with docker-compose
-
-docker-compose.yml contains a stack that will automatically provision SSL certificates for your domain name and will add a https redirect to port 80.
-
-1. Download docker-compose.yml
-2. Change environment variables for `kovan` containers as appropriate
-   - add `PRIVATE_KEY` for your relayer address (without 0x prefix)
-   - set `VIRTUAL_HOST` and `LETSENCRYPT_HOST` to your domain and add DNS record pointing to your relayer ip address
-   - customize `RELAYER_FEE`
-   - update `RPC_URL` if needed
-   - update `REDIS_URL` if needed
-3. Run `docker-compose up -d`
-
-## Run as a Docker container
-
-1. `cp .env.example .env`
-2. Modify `.env` as needed
-3. `docker run -d --env-file .env -p 80:8000 tornadocash/relayer`
-
-In that case you will need to add https termination yourself because browsers with default settings will prevent https
-tornado.cash UI from submitting your request over http connection
-
 ## Input data example
 
 ```json

tornado-stream.conf

@@ -0,0 +1,17 @@
+map $ssl_preread_server_name $name {
+    yourserver.com tornado_mainnet;
+
+    # default
+
+    default tornado_mainnet;
+}
+
+upstream tornado_mainnet {
+    server 127.0.0.1:4380;
+}
+
+server {
+    listen 0.0.0.0:443;
+    proxy_pass $name;
+    ssl_preread on;
+}

tornado.conf

@@ -0,0 +1,70 @@
+# If we receive X-Forwarded-Proto, pass it through; otherwise, pass along the
+# scheme used to connect to this server
+map $http_x_forwarded_proto $proxy_x_forwarded_proto {
+  default $http_x_forwarded_proto;
+  ''      $scheme;
+}
+# If we receive X-Forwarded-Port, pass it through; otherwise, pass along the
+# server port the client connected to
+map $http_x_forwarded_port $proxy_x_forwarded_port {
+  default $http_x_forwarded_port;
+  ''      $server_port;
+}
+# If we receive Upgrade, set Connection to "upgrade"; otherwise, delete any
+# Connection header that may have been passed to this server
+map $http_upgrade $proxy_connection {
+  default upgrade;
+  '' close;
+}
+# Apply fix for very long server names
+server_names_hash_bucket_size 128;
+# Default dhparam
+# Set appropriate X-Forwarded-Ssl header based on $proxy_x_forwarded_proto
+map $proxy_x_forwarded_proto $proxy_x_forwarded_ssl {
+  default off;
+  https on;
+}
+gzip_types text/plain text/css application/javascript application/json application/x-javascript text/xml application/xml application/xml+rss text/javascript;
+log_format vhost '$host $remote_addr - $remote_user [$time_local] '
+                 '"$request" $status $body_bytes_sent '
+                 '"$http_referer" "$http_user_agent" '
+                 '"$upstream_addr"';
+# HTTP 1.1 support
+proxy_http_version 1.1;
+proxy_buffering off;
+proxy_set_header Host $http_host;
+proxy_set_header Upgrade $http_upgrade;
+proxy_set_header Connection $proxy_connection;
+proxy_set_header X-Real-IP $remote_addr;
+proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+proxy_set_header X-Forwarded-Proto $proxy_x_forwarded_proto;
+proxy_set_header X-Forwarded-Ssl $proxy_x_forwarded_ssl;
+proxy_set_header X-Forwarded-Port $proxy_x_forwarded_port;
+proxy_set_header X-Original-URI $request_uri;
+# Mitigate httpoxy attack (see README for details)
+proxy_set_header Proxy "";
+
+server {
+	server_name _; # This is just an invalid value which will never trigger on a real hostname.
+	server_tokens off;
+	listen 80;
+	access_log /var/log/nginx/access.log vhost;
+	return 503;
+}
+
+server {
+	server_name yourdomain.com;
+
+	listen 80 ;
+	access_log /var/log/nginx/access.log vhost;
+
+	# Do not HTTPS redirect Let'sEncrypt ACME challenge
+	location ^~ /.well-known/acme-challenge/ {
+        proxy_pass  http://127.0.0.1:8080;
+		break;
+	}
+
+	location / {
+		return 301 https://$host$request_uri;
+	}
+}