From e1d040bd55ababec2a2dcd91b35c772b5c3e0d5a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ferdinand=20M=C3=BCtsch?= <ferdinand@muetsch.io>
Date: Sun, 4 Apr 2021 10:23:35 +0200
Subject: [PATCH] docs: mention wiki in docs

---
 README.md              |  4 +++-
 docs/advanced_setup.md | 47 ------------------------------------------
 2 files changed, 3 insertions(+), 48 deletions(-)
 delete mode 100644 docs/advanced_setup.md

diff --git a/README.md b/README.md
index 2591ff4..cfab4a4 100644
--- a/README.md
+++ b/README.md
@@ -49,6 +49,8 @@
 * [Support](#-support)
 * [FAQs](#-faqs)
 
+Further instructions can be found in the [Wiki](https://github.com/muety/wakapi/wiki).
+
 ## 📬 **User Survey**
 I'd love to get some community feedback from active Wakapi users. If you want, please participate in the recent [user survey](https://github.com/muety/wakapi/issues/82). Thanks a lot!
 
@@ -149,7 +151,7 @@ api_url = http://localhost:3000/api/heartbeat
 api_key = 406fe41f-6d69-4183-a4cc-121e0c524c2b
 ```
 
-Optionally, you can set up a [client-side proxy](docs/advanced_setup.md) in addition.
+Optionally, you can set up a [client-side proxy](https://github.com/muety/wakapi/wiki/Advanced-Setup:-Client-side-proxy) in addition.
 
 ## 🔧 Configuration Options
 You can specify configuration options either via a config file (default: `config.yml`, customziable through the `-c` argument) or via environment variables. Here is an overview of all options.
diff --git a/docs/advanced_setup.md b/docs/advanced_setup.md
deleted file mode 100644
index f24df11..0000000
--- a/docs/advanced_setup.md
+++ /dev/null
@@ -1,47 +0,0 @@
-# Advanced Setup
-This page contains instructions for additional setup options, none of which are mandatory.
-
-## Optional: Client-side proxy
-Most Wakatime plugins work in a way that, for every heartbeat to send, the plugin calls your local [wakatime-cli](https://github.com/wakatime/wakatime) (a small Python program that is automatically installed when installing a Wakatime plugin) with a few command-line arguments, which is then run as a new process. Inside that process, a heartbeat request is forged and sent to the backend API – Wakapi in this case.
-
-While this is convenient for plugin developers, as they do not have to deal with sending HTTP requests, etc., it comes with a minor drawback. Because the CLI process shuts down after each request, its TCP connection is closed as well. Accordingly, **TCP connections cannot be re-used** and every single heartbeat request is inevitably preceded by the `SYN` + `SYN ACK` + `ACK` sequence for establishing a new TCP connection as well as a handshake for establishing a new TLS session.
-
-While this certainly does not hurt, it is still a bit of overhead. You can avoid that by setting up a local reverse proxy on your machine, that keeps running as a daemon and can therefore keep a continuous connection.
-
-### Option 1: [tinyproxy](https://tinyproxy.github.io) forward proxy (`Linux`, `Mac` only)
-In this example we use _tinyproxy_ as a small, easy-to-install proxy server, written in C, that runs on your local machine.
-1. Install [tinyproxy](https://tinyproxy.github.io)
-   * Fedora / RHEL: `dnf install tinyproxy`
-   * Debian / Ubuntu: `apt install tinyproxy`
-   * MacOS: Install from [MacPorts](https://ports.macports.org/port/tinyproxy/summary)
-1. Enable and start it
-   * Linux: `sudo systemctl start tinyproxy && sudo systemctl enable tinyproxy`
-   * Mac: Not sure, sorry ¯\_(ツ)_/¯
-1. Update `~/.wakatime.cfg`
-   * Set `proxy = http://localhost:8888`
-1. Done
-   * All Wakapi requests are passed through tinyproxy now, which keeps a TCP connection with the server open for some time
-
-### Option 2: [Caddy](https://caddyserver.com) reverse proxy (`Win`, `Linux`, `Mac`)
-In this example, we misuse Caddy, which is a web server and reverse proxy, to fulfil the above scenario. 
-
-1. [Install Caddy](https://caddyserver.com/) 
-    * When installing manually, don't forget to set up a systemd service to start Caddy on system startup
-1. Create a Caddyfile
-    ```
-    # /etc/caddy/Caddyfile
-   
-    http://localhost:8070 {
-        reverse_proxy * {
-            to https://wakapi.dev  # <-- substitute your own Wakapi host here
-            header_up Host {http.reverse_proxy.upstream.host}
-            header_down -Server
-        }
-    }
-    ```
-1. Restart Caddy
-1. Verify that you can access [`http://localhost:8070/api/health`](http://localhost:8070/api/health)
-1. Update `~/.wakatime.cfg`
-    * Set `api_url = http://localhost:8070/api/heartbeat`
-1. Done
-   * All Wakapi requests are passed through Caddy now, which keeps a TCP connection with the server open for some time
\ No newline at end of file