aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6e7a176..50a8d3c 100644
--- a/README.md
+++ b/README.md
@@ -108,6 +108,20 @@ On macOS, use `install-launchd`.
## Hosting
Run it normally behind a reverse proxy (like nginx)
+## Deploy with Docker Compose
+
+You need Docker or Podman and Docker Compose installed on your system.
+
+Run the container:
+
+```
+$ git clone https://git.bwaaa.monster/omnisearch
+$ cd omnisearch
+$ docker compose up -d --build
+```
+
+By default it can be reached on port 5000.
+
## Customisation
To make your own changes while still being able to receive upstream updates: