From fea0ba09f608677b735dedde9ac69f395aba4208 Mon Sep 17 00:00:00 2001
From: Kroese <kroese@users.noreply.github.com>
Date: Wed, 12 Mar 2025 12:31:50 +0100
Subject: [PATCH] docs: Use relative paths (#917)

---
 compose.yml    | 31 ++++++++++++++++---------------
 kubernetes.yml |  4 ----
 readme.md      | 19 ++++++++-----------
 3 files changed, 24 insertions(+), 30 deletions(-)

diff --git a/compose.yml b/compose.yml
index 624f703..4de54bf 100644
--- a/compose.yml
+++ b/compose.yml
@@ -1,16 +1,17 @@
 services:
-    dsm:
-        container_name: dsm
-        image: vdsm/virtual-dsm:latest
-        environment:
-            DISK_SIZE: "16G"
-        devices:
-            - /dev/kvm
-            - /dev/net/tun
-        cap_add:
-            - NET_ADMIN
-        ports:
-            - 5000:5000
-        volumes:
-            - /var/dsm:/storage
-        stop_grace_period: 2m
+  dsm:
+    container_name: dsm
+    image: vdsm/virtual-dsm
+    environment:
+      DISK_SIZE: "16G"
+    devices:
+      - /dev/kvm
+      - /dev/net/tun
+    cap_add:
+      - NET_ADMIN
+    ports:
+      - 5000:5000
+    volumes:
+      - ./dsm:/storage
+    restart: always
+    stop_grace_period: 2m
diff --git a/kubernetes.yml b/kubernetes.yml
index 8c0b7a3..97a04db 100644
--- a/kubernetes.yml
+++ b/kubernetes.yml
@@ -30,10 +30,6 @@ spec:
       - name: dsm
         image: vdsm/virtual-dsm
         env:
-        - name: RAM_SIZE
-          value: "1G"
-        - name: CPU_CORES
-          value: "1"
         - name: DISK_SIZE
           value: "16G"
         ports:
diff --git a/readme.md b/readme.md
index d512774..9422d92 100644
--- a/readme.md
+++ b/readme.md
@@ -39,7 +39,7 @@ services:
     ports:
       - 5000:5000
     volumes:
-      - /var/dsm:/storage
+      - ./dsm:/storage
     restart: always
     stop_grace_period: 2m
 ```
@@ -47,7 +47,7 @@ services:
 Via Docker CLI:
 
 ```bash
-docker run -it --rm -p 5000:5000 --device=/dev/kvm --device=/dev/net/tun --cap-add NET_ADMIN --stop-timeout 120 vdsm/virtual-dsm
+docker run -it --rm --name dsm -p 5000:5000 --device=/dev/kvm --device=/dev/net/tun --cap-add NET_ADMIN -v ${PWD:-.}/dsm:/storage --stop-timeout 120 vdsm/virtual-dsm
 ```
 
 Via Kubernetes:
@@ -84,10 +84,10 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
 
   ```yaml
   volumes:
-    - /var/dsm:/storage
+    - ./dsm:/storage
   ```
 
-  Replace the example path `/var/dsm` with the desired storage folder.
+  Replace the example path `./dsm` with the desired storage folder or named volume.
  
 ### How do I change the size of the disk?
 
@@ -112,9 +112,6 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
     DISK_FMT: "qcow2"
   ```
 
-> [!NOTE]
-> This may reduce the write performance of the disk.
-
 ### How do I add multiple disks?
 
   To create additional disks, modify your compose file like this:
@@ -124,8 +121,8 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
     DISK2_SIZE: "32G"
     DISK3_SIZE: "64G"
   volumes:
-    - /home/example:/storage2
-    - /mnt/data/example:/storage3
+    - ./example2:/storage2
+    - ./example3:/storage3
   ```
 
 ### How do I pass-through a disk?
@@ -245,8 +242,8 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
     - /dev/dri
   ```
 
-> [!TIP]
-> This can be used to enable the facial recognition function in Synology Photos for example.
+> [!NOTE]
+> This can be used to enable the facial recognition function in Synology Photos, but does not provide hardware transcoding for video.
 
 ### How do I install a specific version of vDSM?