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

readme will need rewritten later

Browse Source
This commit is contained in:
Enstrayed
2025-04-22 09:22:54 -07:00
parent c868c9bc09
commit 2ad8d04c99
1 changed files with 2 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@@ -8,49 +8,12 @@ This file contains documentation relevant for development and deployment, but no
If you would like to report a bug or security issue, please open a GitHub issue. If you are the operator of a service this application accesses, use the contact information provided during registration with your service to contact me directly. If you would like to report a bug or security issue, please open a GitHub issue. If you are the operator of a service this application accesses, use the contact information provided during registration with your service to contact me directly.
## Configuration ## Configuration
The configuration is downloaded from CouchDB on startup, however two environment variables must be set to specify the URL of the CouchDB server and the credentials for accessing it:
| Variable | Required? | Purpose |
|--------------|----------------------|-----------------------------------------------------------------------------------------------------|
| `API_PORT` | No, defaults to 8081 | Sets the port the server will listen on |
| `API_DBHOST` | Yes | Complete URL of the CouchDB instance, including port and protocol |
| `API_DBCRED` | Yes | Credentials to access the CouchDB instance, in Basic Authentication format e.g. `username:password` |
<details> <summary>Configuration Example</summary>
* `frontpage.directory`: Directory of frontpage, will be served at root with modifications. <details> <summary>Configuration Template</summary>
* `mailjet.apiKey`: Mailjet API Key.
* `mailjet.senderAddress`: Email address that emails will be received from, must be verified in Mailjet admin panel.
* `nowplaying.*.apiKey`: API key of respective service.
* `nowplaying.*.target`: User that should be queried to retrieve playback information.
```json ```json
{
"frontpage": {
"directory": ""
},
"mailjet": {
"apiKey": "",
"senderAddress": ""
},
"nowplaying": {
"lastfm": {
"apiKey": "",
"target": ""
},
"jellyfin": {
"apiKey": "",
"host": "",
"target": ""
},
"cider": {
"apiKeys": [],
"hosts": []
}
}
}
``` ```
</details> </details>
@@ -58,9 +21,6 @@ The configuration is downloaded from CouchDB on startup, however two environment
## Docker ## Docker
In production, this application is designed to be run in Docker, and the container built by pulling the latest commit from the main branch. As such, deploying this application is just a matter of creating a directory and copying the Dockerfile: In production, this application is designed to be run in Docker, and the container built by pulling the latest commit from the main branch. As such, deploying this application is just a matter of creating a directory and copying the Dockerfile:
> [!IMPORTANT]
> Please review the Configuration section of this document for important information. By default, the `config.json` file is expected to be mounted into the container at `/app/config.json`.
```dockerfile ```dockerfile
FROM node:22 FROM node:22
WORKDIR /app WORKDIR /app
@@ -75,16 +35,7 @@ ENTRYPOINT [ "node", "index.js" ]
<details> <summary>Docker Compose File</summary> <details> <summary>Docker Compose File</summary>
```yaml ```yaml
---
services:
enstrayedapi:
build:
context: .
image: enstrayedapi
container_name: enstrayedapi
restart: unless-stopped
volumes:
- ./config.json:/app/config.json
``` ```
</details> </details>