Create README.md

2022-11-16 22:38:18 -05:00
parent 13bbf8a8ef
commit 79e9162bb7
1 changed files with 39 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,39 @@
+# device-volume-driver
+
+This maps and enables devices into containers running on docker swarm. It is currently only compatible with linux systems that use cgroup v1. Contributions
+for cgroupv2 are welcome.
+
+# Installation
+
+`docker plugin install redcanari/dvd`
+
+# Usage
+
+```yaml
+version: "3.8"
+
+volumes:
+  dev_fuse:
+    driver: redcanari/dvd
+    driver_opts:
+      device: /dev/fuse
+  dev_dri_card0:
+    driver: redcanari/dvd
+    driver_opts:
+      device: /dev/dri/card0
+  dev_dri_renderD128:
+    driver: redcanari/dvd
+    driver_opts:
+      device: /dev/dri/renderD128
+
+services:
+  rdesktop:
+    image: ldr.rc.ai/redcanari/rdesktop
+    volumes:
+      - dev_fuse:/dev/fuse
+      - dev_dri_card0:/dev/dri/card0
+      - dev_dri_renderD128:/dev/dri/renderD128
+    ports:
+      - 3389:3389
+
+```