update readme and api docs

This commit is contained in:
2025-12-15 22:16:53 -08:00
parent a5c3db32d3
commit 28edcb21aa
2 changed files with 17 additions and 116 deletions

View File

@@ -1,72 +1,10 @@
## Note for Visitors
* This README mainly contains information for operation but not usage. API documentation is available [here](https://enstrayed.com/posts/20240409-API-Documentation.html).
* Have feedback or experiencing a problem with an endpoint? Please [open a GitHub issue](https://github.com/Enstrayed/enstrayedapi/issues/new).
* Security problem? [Open a ticket here](https://helpdesk.enstrayed.com/open.php) with the topic set as 'Responsible Disclosure'.
## Note for passersby
* If you have feedback or are experiencing a problem, [click here](https://enstrayed.com/helpdesk/ticket/new?form=TBD).
* If you need to report a security issue, [click here](https://enstrayed.com/helpdesk/ticket/new?form=TBD).
* 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
<details> <summary>Configuration</summary>
```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> <summary>Komodo Files</summary>
```toml
[[build]]
name = "enstrayedapi"
[build.config]
builder = "local"
repo = "Enstrayed/enstrayedapi"
webhook_secret = "nowaybuddy"
```
```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_URL=postgres://nowaybuddy:nowaybuddy@postgres:5432/api
"""
```
</details>
## Links
* [Published API Documentation](https://enstrayed.com/posts/99999999-API-Documentation.html)
* [Internal Use Endpoints](https://git.enstrayed.com/enstrayed/enstrayedapi/wiki/Internal-Use-Endpoints)
* [Configuration Reference](https://git.enstrayed.com/enstrayed/enstrayedapi/wiki/Configuration)
* [Komodo Configuration](https://git.enstrayed.com/enstrayed/enstrayedapi/wiki/Komodo)