Commit 3fec9bf5 authored by Kroese's avatar Kroese Committed by GitHub
Browse files

docs: Readme

docs: Readme
parents 0c1c4227 8d8efeb3
Loading
Loading
Loading
Loading
+4 −2
Original line number Diff line number Diff line
@@ -17,7 +17,7 @@ Virtual DSM in a docker container.
 - Multi-platform
 - KVM acceleration
 - GPU passthrough
 - Graceful shutdown
 - Graceful shutdowns
 - Upgrades supported
 
## Usage
@@ -173,7 +173,7 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti

  * ### How do I passthrough my GPU?

    To enable this feature, add the following lines to your compose file:
    To passthrough your GPU, add the following lines to your compose file:

    ```yaml
    environment:
@@ -182,6 +182,8 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
        - /dev/dri
    ```

    This can be used to enable facial recognition in Synology Photos for example.
    
  * ### What are the differences compared to the standard DSM?

    There are only two minor differences: the Virtual Machine Manager package is not provided, and Surveillance Station doesn't include any free licenses.
+1 −3
Original line number Diff line number Diff line
@@ -55,8 +55,6 @@ _graceful_shutdown() {

    if ((AGENT_VERSION < 2)); then

      echo && info "Please update the VirtualDSM Agent to allow for gracefull shutdowns..."

      kill -15 "$(cat "${_QEMU_PID}")"
      pkill -f qemu-system-x86_64 || true

@@ -72,7 +70,7 @@ _graceful_shutdown() {
    if echo 'info version'| nc -q 1 -w 1 localhost "${QEMU_MONPORT}" >/dev/null 2>&1 ; then

      sleep 1
      #info "Shutting down, waiting... ($(cat ${_QEMU_SHUTDOWN_COUNTER})/${QEMU_POWERDOWN_TIMEOUT})"
      [[ "${DEBUG}" == [Yy1]* ]] && info "Shutting down, waiting... ($(cat ${_QEMU_SHUTDOWN_COUNTER})/${QEMU_POWERDOWN_TIMEOUT})"

    fi