From bd4a23b287ae95719722782a937792af49a050e6 Mon Sep 17 00:00:00 2001 From: Kroese Date: Fri, 19 Jan 2024 12:05:54 +0100 Subject: [PATCH] docs: Readme (#581) --- readme.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/readme.md b/readme.md index 6722661b..1f6c1508 100644 --- a/readme.md +++ b/readme.md @@ -86,7 +86,20 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti Replace the example path `/var/dsm` with the desired storage folder. - * ### How do I add multiple disks? + * ### How do I create a growable disk? + + By default, the entire capacity of the disk is reserved in advance. + + To create a growable disk that only allocates space that is actually used, add the following environment variable: + + ```yaml + environment: + DISK_FMT: "qcow2" + ``` + + Please note that 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: @@ -99,18 +112,22 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti - /mnt/data/example:/storage3 ``` - * ### How do I create a growable disk? - - By default, the entire capacity of the disk is reserved in advance. + * ### How do I pass-through a disk? - To create a growable disk that only allocates space that is actually used, add the following environment variable: + It is possible to pass-through disk devices directly by adding them to your compose file in this way: ```yaml environment: - DISK_FMT: "qcow2" + DEVICE2: "/dev/sda" + DEVICE3: "/dev/sdb" + devices: + - /dev/sda + - /dev/sdb ``` - Please note that this may reduce the write performance of the disk. + Please note that the device needs to be totally empty (without any partition table) otherwise DSM does not always format it into a volume. + + Do NOT use this feature with the goal of sharing files from the host, they will all be lost without warning when DSM creates the volume. * ### How do I increase the amount of CPU or RAM? @@ -199,23 +216,6 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti This can be used to enable the facial recognition function in Synology Photos for example. - * ### How do I pass-through a disk? - - It is possible to pass-through disk devices directly by adding them to your compose file in this way: - - ```yaml - environment: - DEVICE2: "/dev/sda" - DEVICE3: "/dev/sdb" - devices: - - /dev/sda - - /dev/sdb - ``` - - Please note that the device needs to be totally empty (without any partition table) otherwise DSM does not always format it into a volume. - - Do NOT use this feature with the goal of sharing files from the host, they will all be lost without warning when DSM creates the volume. - * ### How do I install a specific version of vDSM? By default, version 7.2 will be installed, but if you prefer an older version, you can add its download URL to your compose file as follows: