Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Readme #581

Merged
merged 1 commit into from
Jan 19, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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?

Expand Down Expand Up @@ -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:
Expand Down