joshpatra/allstarr
1
0
Fork 0
mirror of https://github.com/SoPat712/allstarr.git synced 2026-02-09 23:55:10 -05:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Consolidate Quick Start sections and update to use docker pull

Browse Source
This commit is contained in:
Josh Patra
2026-01-30 11:57:05 -05:00
parent 3af3ebb52b
commit 36a224bd45
1 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -13,19 +13,26 @@ Please report all bugs as soon as possible, as the Jellyfin addition is entirely
## Quick Start ## Quick Start
Using Docker (recommended):
```bash ```bash
# 1. Configure environment # 1. Pull the latest image
docker-compose pull
# 2. Configure environment
cp .env.example .env cp .env.example .env
vi .env # Edit with your settings vi .env # Edit with your settings
# 2. Start services # 3. Start services
docker-compose up -d --build docker-compose up -d
# 3. Check status # 4. Check status
docker-compose ps docker-compose ps
docker-compose logs -f docker-compose logs -f
``` ```
The proxy will be available at `http://localhost:5274`.
### Nginx Proxy Setup (Required) ### Nginx Proxy Setup (Required)
This service only exposes ports internally. You **must** use nginx to proxy to it: This service only exposes ports internally. You **must** use nginx to proxy to it:
@@ -134,11 +141,11 @@ Choose your preferred provider via the `MUSIC_SERVICE` environment variable. Add
- Credentials for at least one music provider (IF NOT USING SQUIDWTF): - Credentials for at least one music provider (IF NOT USING SQUIDWTF):
- **Deezer**: ARL token from browser cookies - **Deezer**: ARL token from browser cookies
- **Qobuz**: User ID + User Auth Token from browser localStorage ([see Wiki guide](https://github.com/V1ck3s/allstarr/wiki/Getting-Qobuz-Credentials-(User-ID-&-Token))) - **Qobuz**: User ID + User Auth Token from browser localStorage ([see Wiki guide](https://github.com/V1ck3s/allstarr/wiki/Getting-Qobuz-Credentials-(User-ID-&-Token)))
- Docker and Docker Compose (recommended) **or** [.NET 9.0 SDK](https://dotnet.microsoft.com/download/dotnet/9.0) for manual installation - Docker and Docker Compose (recommended) **or** [.NET 10.0 SDK](https://dotnet.microsoft.com/download/dotnet/10.0) for manual installation
## Quick Start (Docker) ## Configuration
The easiest way to run Allstarr is with Docker Compose. ### Environment Setup
1. **Create your environment file** 1. **Create your environment file**
```bash ```bash
@@ -188,20 +195,13 @@ The easiest way to run Allstarr is with Docker Compose.
See the full `.env.example` for all available options including Deezer/Qobuz credentials. See the full `.env.example` for all available options including Deezer/Qobuz credentials.
3. **Start the container** 3. **Configure your client**
```bash
docker-compose up -d
```
The proxy will be available at `http://localhost:5274`.
4. **Configure your client**
Point your music client to `http://localhost:5274` instead of your media server directly. Point your music client to `http://localhost:5274` instead of your media server directly.
> **Tip**: Make sure the `DOWNLOAD_PATH` points to a directory that your media server can scan, so downloaded songs appear in your library. > **Tip**: Make sure the `DOWNLOAD_PATH` points to a directory that your media server can scan, so downloaded songs appear in your library.
## Configuration ## Advanced Configuration
### Backend Selection ### Backend Selection