jackc/slop-farmer-server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add info to README

Browse Source
This commit is contained in:
Jack Case
2025-10-27 14:35:31 -04:00
committed by GitHub
parent 360872fdd0
commit f0bed2783e
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -1 +1,11 @@
# slop-farmer-server
# slop-farmer-server
FastAPI-based server to form the backend of the Slop Farmer browser extension.
Handles user authentication, requests to check search result URLs against reported slop,
and new reports of slop URLs from users.
## Docker Container
run the server with `docker run -P --env-file <env file> slopfarmer`
## Environment Variables
DB_URL - The url connection string to pass to SQLAlchemy
TOKEN_SECRET - the secret used for signing JWTs used for user auth after login