From 06242dfd386c7cdeabf04857e733a468d646646e Mon Sep 17 00:00:00 2001
From: rgpublic <rgpublic@gmx.net>
Date: Fri, 12 Jul 2019 16:07:24 +0200
Subject: [PATCH] Add deployment instructions (#1366)

---
 README.md          |  7 +++++
 docs/deployment.md | 68 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 75 insertions(+)
 create mode 100644 docs/deployment.md

diff --git a/README.md b/README.md
index 64b8f57d..6f482186 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,7 @@
 * [Localization](#localization)
 * [Contributing](#contributing)
 * [Testing](#testing)
+* [Deployment](#deployment)
 * [Android](#android)
 * [License](#license)
 
@@ -91,6 +92,12 @@ Pull requests are always welcome! Feel free to check out the list of ["good firs
 
 ---
 
+## Deployment
+
+see also [docs/deployment.md](docs/deployment.md)
+
+---
+
 ## Android
 
 The android implementation is contained in the `android` directory, and can be viewed locally for easy testing and editing by running `ANDROID=1 npm start` and then visiting <http://localhost:8080>. CSS and image files are located in the `android/app/src/main/assets` directory.
diff --git a/docs/deployment.md b/docs/deployment.md
new file mode 100644
index 00000000..3a8bd8b0
--- /dev/null
+++ b/docs/deployment.md
@@ -0,0 +1,68 @@
+## Requirements
+This document describes how to do a full deployment of Firefox Send on your own Linux server. You will need:
+
+* A working (and ideally somewhat recent) installation of NodeJS and NPM
+* GIT
+* An Apache webserver
+* Optionally telnet, to be able to quickly check your installation
+
+For Debian/Ubuntu systems this probably just means something like this:
+
+* apt install git apache2 nodejs npm telnet
+
+## Building
+* We assume an already configured virtual-host on your webserver with an existing empty htdocs folder
+* First, remove that htdocs folder - we will replace it with Firefox Send's version now
+* git clone https://github.com/mozilla/send.git htdocs
+* Make now sure you are NOT root but rather the user your webserver is serving files under (e.g. "su www-data" or whoever the owner of your htdocs folder is)
+* npm install
+* npm run build
+
+## Running
+To have a permanently running version of Firefox Send as a background process:
+
+* Create a file "run.sh" with:
+```
+#!/bin/bash
+nohup su www-data -c "npm run prod" 2>/dev/null &
+```
+* chmod +x run.sh
+* ./run.sh
+
+Now the Firefox Send backend should be running on port 1443. You can check with:
+* telnet localhost 1443
+
+## Reverse Proxy
+Of course, we don't want to expose the service on port 1443. Instead we want our normal webserver to forward all requests to Firefox send ("Reverse proxy").
+
+# Apache webserver
+
+* a2enmod proxy
+* a2enmod proxy_http
+* a2enmod proxy_wstunnel
+
+In your Apache virtual host configuration file, insert this:
+
+```
+    # Enable rewrite engine
+    RewriteEngine on
+
+    # Make sure the original domain name is forwarded to Send
+    # Otherwise the generated URLs will be wrong
+    ProxyPreserveHost on
+
+    # Make sure the generated URL is https://
+    RequestHeader set X-Forwarded-Proto https
+
+    # If it's a normal file (e.g. PNG, CSS) just return it
+    RewriteCond %{REQUEST_FILENAME} -f
+    RewriteRule .* - [L]
+
+    # If it's a websocket connection, redirect it to a Send WS connection
+    RewriteCond %{HTTP:Upgrade} =websocket [NC]
+    RewriteRule /(.*) ws://127.0.0.1:1443/$1 [P,L]
+
+    # Otherwise redirect it to a normal HTTP connection
+    RewriteRule ^/(.*)$ http://127.0.0.1:1443/$1 [P,QSA]
+    ProxyPassReverse  "/" "http://127.0.0.1:1443"
+```