From b0e4e0f26c3b3e64055851cc854fbcdcb43adc1e Mon Sep 17 00:00:00 2001 From: Enstrayed <48845980+Enstrayed@users.noreply.github.com> Date: Fri, 13 Jun 2025 23:37:09 -0700 Subject: [PATCH] revise readme --- README.md | 70 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 52 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 8b94f5c..242b130 100644 --- a/README.md +++ b/README.md @@ -5,34 +5,68 @@ * This code is unlicensed but I don't really care if you use parts of it (I don't know why you would though). ## Configuration -TODO: Rewrite -
Configuration Template +
Configuration ```json - +{ + "oidc": { + "clientId": "nowaybuddy", + "tokenUrl": "https://login.enstrayed.com/application/o/token/", + "userinfoUrl": "https://login.enstrayed.com/application/o/userinfo/", + "authorizeUrl": "https://login.enstrayed.com/application/o/authorize/", + "clientSecret": "nowaybuddy" + }, + "email": { + "host": "orenco.enstrayed.com", + "password": "nowaybuddy", + "username": "nowaybuddy" + }, + "nowplaying": { + "cider": { + "hosts": [], + "apiKeys": [] + }, + "lastfm": { + "apiKey": "nowaybuddy", + "target": "enstrayed" + }, + "jellyfin": { + "host": "http://hawthorne.pizzly-catfish.ts.net:8096", + "apiKey": "nowaybuddy", + "target": "nathan", + "hostPublic": "https://jellyfin.enstrayed.com" + } + } +} ```
-## Docker -TODO: Rewrite & add Komodo TOML files +
Komodo Files -```dockerfile -FROM node:22 -WORKDIR /app -RUN git clone https://github.com/enstrayed/enstrayedapi . -RUN npm install - -USER node -ENTRYPOINT [ "node", "index.js" ] +```toml +[[build]] +name = "enstrayedapi" +[build.config] +builder = "local" +repo = "Enstrayed/enstrayedapi" +webhook_secret = "nowaybuddy" ``` - -
Docker Compose File - -```yaml - +```toml +[[deployment]] +name = "enstrayedapi" +[deployment.config] +server = "hawthorne" +image.type = "Build" +image.params.build = "enstrayedapi" +network = "caddy" +restart = "unless-stopped" +extra_args = ["--network=postgres"] +environment = """ +DATABASE_URI=postgres://nowaybuddy:nowaybuddy@postgres:5432/api +""" ```
\ No newline at end of file