From 3c8224cb4dd05b921371bd3c985b318b68751e40 Mon Sep 17 00:00:00 2001 From: jabuxas Date: Fri, 6 Sep 2024 16:35:01 -0300 Subject: [PATCH] docs: update docs on variables --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 236e075..5569e4f 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,6 @@ docker compose up -d # might be docker-compose depending on distro - you can optionally use the [docker image](https://git.jabuxas.xyz/jabuxas/-/packages/container/abyss/latest) directly and set it up how you want -- dont change inside port of 8999 unless you know what you're doing - ### manual - to run it manually, build it with `go build -o abyss` and run: @@ -48,8 +46,10 @@ curl -F "file=@/path/to/file" -H "X-Auth: "$(cat /path/to/.key) http://localhost ## docs - `ABYSS_URL`: this is used for the correct formatting of the response of `curl`. -- `AUTH_USERNAME | AUTH_PASSWORD`: this is used to access `http://localhost:8999/tree`, which shows all uploaded files +- `AUTH_USERNAME | AUTH_PASSWORD`: this is used to access `/tree/`, which shows all uploaded files - `UPLOAD_KEY`: this is key checked when uploading files. if the key doesn't match with server's one, then it refuses uploading. +- `ABYSS_FILEDIR`: this points to the directory where abyss will save the uploads to. defaults to `./files` +- `ABYSS_PORT`: this is the port the server will run on. safe to leave empty. defaults to 3235 ## todo: