Readme: Add data directory mount to docker run command and explanatory note (#824)
authorKris Noble <872971+krisnoble@users.noreply.github.com>
Tue, 8 Aug 2023 12:35:21 +0000 (13:35 +0100)
committerGitHub <noreply@github.com>
Tue, 8 Aug 2023 12:35:21 +0000 (14:35 +0200)
* add data directory mount and note to avoid losing data between updates

README.md

index cabd07b75194a6fd1971401f93913c5423c35e95..a7fc634481439021035c6d2eda49810215e3d890 100644 (file)
--- a/README.md
+++ b/README.md
@@ -39,10 +39,10 @@ By far the most convenient way to run the Music Assistant Server is to install t
 An alternative way to run the Music Assistant server is by running the docker image:
 
 ```
-docker run --network host --privileged ghcr.io/music-assistant/server
+docker run --network host --privileged -v <dir>:/data ghcr.io/music-assistant/server
 ```
 
-You must run the docker container with host network mode and the data volume is `/data`.
+You must run the docker container with host network mode. The data volume is `/data` - replace `<dir>` with a writable directory to ensure the data volume persists between updates.
 If you want access to your local music files from within MA, make sure to also mount that, e.g. /media.
 Note that accessing remote (SMB) shares can be done from within MA itself using the SMB File provider (but requires the privileged flag).