Add section on common Docker issues and SELinux permissions

3155de18866fc84c438a1b71026ab3c65f5aed65

Cohee <18619528+Cohee1207@users.noreply.github.com>

1 files changed, +22 -0Showing whitespace changes
.github/readme.md+22 -0
@@ -232,6 +232,28 @@ docker run \
232232
233233We have a comprehensive guide on using SillyTavern in Docker [here](http://docs.sillytavern.app/installation/docker/) which covers installations on Windows, macOS and Linux! Give it a read if you wish to build the image yourself.
234234
235+### Common issues with Docker
236+
237+#### SELinux Permission Issues with Mounted Volumes
238+
239+Linux distributions with SELinux enabled (such as RHEL, CentOS, Fedora, etc.) may prevent Docker containers from accessing mounted volumes due to security policies. This can result in permission denied errors when the container tries to read or write to the mounted directories.
240+
241+Two suffixes `:z` or `:Z` can be added to the volume mount. These suffixes tell Docker to relabel file objects on the shared volumes.
242+
243+* The `z` option is used when the volume content will be shared between containers.
244+* The `Z` option is used when the volume content should only be used by the current container.
245+
246+Example:
247+
248+```yaml
249+# docker-compose.yml
250+volumes:
251+ ## Shared volume
252+ - ./config:/home/node/app/config:z
253+ ## Private volume
254+ - ./data:/home/node/app/data:Z
255+```
256+
235257## ⚡ Installing via SillyTavern Launcher
236258
237259SillyTavern Launcher is an installation wizard that will help you get setup with many options, including installing a backend for local inference.