Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AbstractUmbra committed Feb 1, 2025
1 parent 00d5af1 commit f978a34
Showing 1 changed file with 2 additions and 17 deletions.
19 changes: 2 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:-
Expand All @@ -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.

0 comments on commit f978a34

Please sign in to comment.