enstrayed/enstrayedapi
1
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

revise readme

Browse Source
This commit is contained in:
Enstrayed
2025-06-13 23:37:09 -07:00
parent fb0953c50c
commit b0e4e0f26c
1 changed files with 52 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
README.md
View File

@@ -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). * 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 ## Configuration
TODO: Rewrite
<details> <summary>Configuration Template</summary> <details> <summary>Configuration</summary>
```json ```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"
}
}
}
``` ```
</details> </details>
## Docker <details> <summary>Komodo Files</summary>
TODO: Rewrite & add Komodo TOML files
```dockerfile
FROM node:22
WORKDIR /app
RUN git clone https://github.com/enstrayed/enstrayedapi . ```toml
RUN npm install [[build]]
name = "enstrayedapi"
USER node [build.config]
ENTRYPOINT [ "node", "index.js" ] builder = "local"
repo = "Enstrayed/enstrayedapi"
webhook_secret = "nowaybuddy"
``` ```
```toml
<details> <summary>Docker Compose File</summary> [[deployment]]
name = "enstrayedapi"
```yaml [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
"""
``` ```
</details> </details>