heimoshuiyu/gonic
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

add config options to readme

Browse Source
This commit is contained in:
sentriz
2019-11-24 01:31:42 +00:00
parent 986c997559
commit 8241b93e43
1 changed files with 22 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -17,10 +17,11 @@
## installation ## installation
The default login is **admin**/**admin**. the default login is **admin**/**admin**.
password can then be change from web interface
``` ```
$ apt install sqlite tablib libtag1-dev $ apt install sqlite libtag1-dev
$ go get senan.xyz/g/gonic/cmd/gonic $ go get senan.xyz/g/gonic/cmd/gonic
$ gonic -h $ gonic -h
``` ```
@@ -28,20 +29,27 @@ $ gonic -h
or with docker, available on dockerhub as `sentriz/gonic` or with docker, available on dockerhub as `sentriz/gonic`
```yaml ```yaml
gonic: gonic:
image: sentriz/gonic:latest image: sentriz/gonic:latest
environment: environment:
- TZ - TZ
- GONIC_MUSIC_PATH=/music # optionally, see env vars below
- GONIC_DB_PATH=/data/db.db expose:
- GONIC_LISTEN_ADDR=:80 - 80
expose: volumes:
- 80 - ./data:/data
volumes: - ${YOUR_MUSIC}:/music:ro
- ./data:/data
- ${YOUR_MUSIC}:/music:ro
``` ```
## configuration options
|env var|command line arg|description|
|---|---|---|
|`GONIC_MUSIC_PATH`|`-music-path`|path to your music collection|
|`GONIC_DB_PATH`|`-db-path`|**optional** path to database file|
|`GONIC_LISTEN_ADDR`|`-listen-addr`|**optional** host and port to listen on (eg. `0.0.0.0:4747`, `127.0.0.1:4747`) (*default* `0.0.0.0:4747`)|
|`GONIC_SCAN_INTERVAL`|`-scan-interval`|**optional** interval (in minutes) to check for new music (automatic scanning disabled if omitted)|
## screenshots ## screenshots
<p align="center"> <p align="center">