summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoreltrac <hi@eltr.ac>2026-03-10 15:05:46 +0800
committereltrac <hi@eltr.ac>2026-03-10 15:05:46 +0800
commitedb78b32c895d57a73c32d4bffbb2e4fb7ae083b (patch)
tree42dff7807a15560a26fb11b46631203bc049e931 /README.md
parent51b9c56882da6a5f6483bde74e40e5eaf323c186 (diff)
docs: add Dockerfile and installation instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 39 insertions, 1 deletions
diff --git a/README.md b/README.md
index 617777f..21d7f6a 100644
--- a/README.md
+++ b/README.md
@@ -34,7 +34,45 @@ You can configure this endpoint path. There are not separate endpoints for diffe
Respond with a JSON array containing all webmentions by default. Accepts query `filter`, either a target URL or a domain name, e.g. `/api/mentions?filter=example.com`.
-## Config
+## Installation
+
+### Download uberjar
+
+For now, there is no pre-built jar provided.
+
+### Build from source
+
+Make sure you have [Leinigen](https://leiningen.org/) installed.
+
+```shell
+git clone https://codeberg.org/eltrac/weepinbell
+cd weepinbell
+lein uberjar
+```
+
+Run the jar file.
+
+```shell
+java -jar weepinbell-0.1.0-SNAPSHOT-standalone.jar
+```
+
+### Docker
+
+```docker-compose
+services:
+ weepinbell:
+ build: .
+ container_name: weepinbell
+ ports:
+ - "3000:3000"
+ environment:
+ - PORT=3000
+ restart: always
+ volumes:
+ - ./data:/app/data
+```
+
+## Configuration
Configure weepinbell by creating a `config.edn`, the defaults: