From f978a344f92b817fc87799a932eaa0678a324b04 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20N=C3=B8rgaard?= Date: Sat, 1 Feb 2025 23:06:38 +0000 Subject: [PATCH] update readme --- README.md | 19 ++----------------- 1 file changed, 2 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index ccda125..137af4f 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,7 @@ ## Running this -There's a provided Dockerfile as well as published image on GHCR. -An example docker compose file that can run this is the following:- - -```yaml -services: - rtfs: - image: ghcr.io/abstractumbra/rtfs - container_name: rtfs - ports: - - 8130:8130 - secrets: - API_KEY_FILE: /run/secrets/api_key - -secrets: - api_key: - file: ./api_key -``` +There's a provided compose & Dockerfile as well as published image on GHCR. You need to provide the secrets file which contains the owner/admin api key. You can make one really quickly using the following command:- @@ -29,3 +13,4 @@ Which will generate a secure and random key for you. ### No Docker You can run this by installing the necessary dependencies defined in the `pyproject.toml` and running `run.py`. You'll need to set an `API_KEY_FILE` environment variable in this case which points to a file with a secure key within. +Optionally, if you want to run this on localhost only, set a `RTFS` environment variable with any value.