Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 29 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,44 +19,50 @@ This allows, for example, someone to then point Lidarr to the URL using the cust

## Installation

At the moment, this isnt containerized and requires node.js

Follow Run locally below, then add the URL to lidarr under Settings>Import Lists>Custom List
### unRaid community apps
*soon*

### docker-compose

```yaml
services:
server:
image: ghcr.io/shadowalker125/recommendarr:latest
container_name: recommendarr
environment:
PUID: 1000
PGID: 1000
NODE_ENV: production
USERS: ""
LISTS: ""
ports:
- "4500:4500"
```


## Environment Variables

To run this project, you will need to update the following environment variables to your .env file

`USER`

`LISTS`


## Run Locally
Users is an array of any Listenbrainz usernames:

Clone the project
`USERS`

```bash
git clone https://github.com/Shadowalker125/recommendarr.git
```
Lists is any of the created lists in listenbrainz. "weekly-exploration" is the recommended one

Install dependencies
`LISTS`

```bash
npm install
```
## Usage/Examples

Start the server
To use with Lidarr, open Settings > Import Lists > Add List > Custom List

```bash
npm run start
```
Change settings to your liking regarding monitoring, quality profile, etc...

For the List URL, simply add the url and port '4500' for the running instance of recommendarr

## Usage/Examples
ex: 'http://localhost:4500'

spits out JSON object on localhost:4500
spits out JSON object

```json
[{"MusicBrainzId":"41656317-c512-456f-9fe7-1f7fb8482a34"},
Expand Down