sickprodigy/sptnr
1
0
Fork 0
forked from CopyBot/sptnr
Code Pull Requests Activity

chore: update readme

Browse Source
This commit is contained in:
Kevin Restaino
2024-01-07 14:27:57 -05:00
parent 464d6a8ef3
commit c466c6d975
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -1
View File
@@ -24,7 +24,7 @@ This script was developed as a solution to repurpose the star ratings in Navidro
You can easily run the script using a pre-built public Docker image. This method is straightforward and does not require building the Docker image locally. You can use the following Docker command and replace the environment variable values with your own: You can easily run the script using a pre-built public Docker image. This method is straightforward and does not require building the Docker image locally. You can use the following Docker command and replace the environment variable values with your own:
```console ```console
docker run \ docker run -t \
-e NAV_BASE_URL=your_navidrome_server_url \ -e NAV_BASE_URL=your_navidrome_server_url \
-e NAV_USER=your_navidrome_username \ -e NAV_USER=your_navidrome_username \
-e NAV_PASS=your_navidrome_password \ -e NAV_PASS=your_navidrome_password \
@@ -33,6 +33,8 @@ docker run \
krestaino/sptnr:latest krestaino/sptnr:latest
``` ```
**Note**: The `-t` flag is used to allocate a pseudo-terminal which assists in displaying colored and bold text in the terminal output, which this script uses.
### Using Docker Compose ### Using Docker Compose
1. **Create `docker-compose.yml` File**: Set up your `docker-compose.yml` file with the following content, replacing the environment variables with your own details: 1. **Create `docker-compose.yml` File**: Set up your `docker-compose.yml` file with the following content, replacing the environment variables with your own details: