From 3dcb5ef4af98145e129a8782accefb6176544174 Mon Sep 17 00:00:00 2001
From: Kenneth <kennethnym@hey.com>
Date: Wed, 4 Dec 2024 18:43:59 +0000
Subject: [PATCH] chore: add manual installation instructions

---
 README.md | 33 +++++++++++++++++++++++++++++++--
 1 file changed, 31 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index fc339a1..59f3443 100644
--- a/README.md
+++ b/README.md
@@ -45,14 +45,38 @@ i am open to feature requests. however, limited time/effort will be spent on thi
 > [!IMPORTANT]
 > Before installing tesseract, make sure that your machine has docker installed.
 
+### Using the installation script
+
 Run the following command:
 
 ```sh
 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/kennethnym/tesseract/refs/heads/master/scripts/install.sh)"
 ```
 
-The installation script will install tesseract to `/opt/tesseract/`. To start tesseract, run the `tesseract` binary,
-which runs tesseract in foreground.
+The installation script will install tesseract to `/opt/tesseract/`.
+After the script finishes, update the `"hostName"` config in `/opt/tesseract/config.json`
+
+### Manual installation
+
+1. Download the appropriate binary from the [releases page](https://github.com/kennethnym/tesseract/releases/).
+2. Extract the file to wherever you want (`/opt/tesseract` is used for the installation script)
+3. Create a file named `config.json` and paste the content below
+4. Update the `"hostName"` config to the host name of the server running tesseract (e.g. tesseract.myserver.lab)
+
+Content of config.json:
+
+```json
+{
+  "port": 80,
+  "databasePath": "./data.sqlite",
+  "hostName": "HOSTNAME",
+  "debug": false
+}
+```
+
+## Running tesseract
+
+To start tesseract, run the `tesseract` binary, which runs tesseract in foreground.
 
 You can also run tesseract in the background:
 
@@ -63,6 +87,11 @@ nohup ./tesseract > ~/tesseract.log 2>&1 &
 
 Write down the PID so that you can kill it later.
 
+
+## Uninstallation
+
+Remove `/opt/tesseract` or the directory containing the tesseract binary and related files.
+
 ## Configuration
 
 A `config.json` must be present in `/opt/tesseract`. It contains configurable options for tesseract: