AuxXxilium/arv-v-dsm
1
0
Fork 0
mirror of https://github.com/AuxXxilium/arv-v-dsm.git synced 2024-11-23 23:10:58 +07:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Readme (#581)

Browse Source
This commit is contained in:
Kroese 2024-01-19 12:05:54 +01:00 committed by GitHub
parent 1b8c4d9f08
commit bd4a23b287
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
readme.md
View File

@ -86,19 +86,6 @@ 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. Replace the example path `/var/dsm` with the desired storage folder.
* ### How do I add multiple disks?
To create additional disks, modify your compose file like this:
```yaml
environment:
DISK2_SIZE: "32G"
DISK3_SIZE: "64G"
volumes:
- /home/example:/storage2
- /mnt/data/example:/storage3
```
* ### How do I create a growable disk? * ### How do I create a growable disk?
By default, the entire capacity of the disk is reserved in advance. By default, the entire capacity of the disk is reserved in advance.
@ -112,6 +99,36 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
Please note that this may reduce the write performance of the disk. 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:
```yaml
environment:
DISK2_SIZE: "32G"
DISK3_SIZE: "64G"
volumes:
- /home/example:/storage2
- /mnt/data/example:/storage3
```
* ### 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 increase the amount of CPU or RAM? * ### How do I increase the amount of CPU or RAM?
By default, a single CPU core and 1 GB of RAM are allocated to the container. By default, a single CPU core and 1 GB of RAM are allocated to the container.
@ -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. 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? * ### 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: 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: