From 068e8d09a392a7ba3d57b5eb8484ea5b7723c474 Mon Sep 17 00:00:00 2001
From: Nikita Karamov <me@kytta.dev>
Date: Thu, 16 Mar 2023 15:21:16 +0100
Subject: [PATCH] Update self-hosting instructions

---
 README.md | 44 +++++++++++++++++++++++++-------------------
 1 file changed, 25 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index 19e2bdf..f277c1c 100644
--- a/README.md
+++ b/README.md
@@ -25,67 +25,73 @@ To deploy it yourself (it's free!), you can use the following button:
 
 [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fkytta%2Fshare2fedi)
 
-<!-- TODO: update the selfhosting instructions -->
-<!--
 ### Host it yourself
 
 Self-hosting **Share₂Fedi** outside of Vercel requires some extra setup:
 
-1. Make sure you have got Node.js v12 or later as well as pnpm installed
+**Prerequisites:** modern Node.js (v16 or later), `pnpm`.
 
-2. Build the static part of toot:
+1. Install the dependencies:
 
    ```sh
-   pnpm install    # to install dependencies
-   pnpm run build  # to build the website
+   pnpm install
+   ```
+
+2. Build the static files:
+
+   ```sh
+   pnpm build
    ```
 
 3. Run the backend server for the form:
 
    ```sh
-   node api/toot.js
+   node api/share.js
    ```
 
-   or if you want to run the process in the background:
+   alternatively, if you want to run the process in the background:
 
    ```sh
-   pm2 start api/toot.js --watch --ignore-watch="node_modules"
+   pm2 start api/share.js --watch --ignore-watch="node_modules"
    ```
 
    > You can find a summary for pm2 at: https://pm2.keymetrics.io/docs/usage/quick-start/
 
-4. Set up webserver
+4. Set up a web server
+
+   Basically, you need to run a server that would proxy the requests to `/api/share`.
+   to the Node.js server you started. Here's how to achieve this in various HTTP
+   servers:
 
    1. Apache
 
    ```apacheconf
-   DocumentRoot "path_to_toot/public"
+   DocumentRoot "<PATH_TO_SHARE2FEDI>/dist"
 
-   ProxyPass "/api/toot"  "http://localhost:8000/"
+   ProxyPass "/api/share"  "http://localhost:8080/"
    ```
 
    2. Nginx
 
    ```nginxconf
-   root path_to_toot/public;
+   root <PATH_TO_SHARE2FEDI>/dist;
    index.html;
 
-   location /api/toot {
-       proxy_pass http://localhost:8000/;
+   location /api/share {
+       proxy_pass http://localhost:8080/;
    }
    ```
 
    3. Caddy
 
    ```caddy
-   root * path_to_toot/public;
+   root * <PATH_TO_SHARE2FEDI>/dist;
    try_files index.html
 
-   handle_path /api/toot {
-      reverse_proxy localhost:8000
+   handle_path /api/share {
+      reverse_proxy localhost:8080
    }
    ```
--->
 
 ## See also