Mirrored_Repos/prusaslicer-novnc
1
0
Fork 0
mirror of https://github.com/helfrichmichael/prusaslicer-novnc.git synced 2024-08-30 18:32:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add docker-compose instructions to README.md, small markdown formatting changes

Browse Source
This commit is contained in:
MrLaFitte 2023-12-04 09:32:08 -06:00 committed by GitHub
parent f95876c298
commit d2969624a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -8,27 +8,33 @@ A lot of this was branched off of dmagyar's awesome [prusaslicer-vnc-docker](htt
## How to use
**In unraid**
### In unraid
If you're using unraid, open your Docker page and under `Template repositories`, add `https://github.com/helfrichmichael/unraid-templates` and save it. You should then be able to Add Container for prusaslicer-novnc. For unraid, the template will default to 6080 for the noVNC web instance.
**Outside of unraid**
### Outside of unraid
#### Docker
To run this image, you can run the following command: `docker run --detach --volume=prusaslicer-novnc-data:/configs/ --volume=prusaslicer-novnc-prints:/prints/ -p 8080:8080 -e SSL_CERT_FILE="/etc/ssl/certs/ca-certificates.crt"
--name=prusaslicer-novnc prusaslicer-novnc`
This will bind `/configs/` in the container to a local volume on my machine named `prusaslicer-novnc-data`. Additionally it will bind `/prints/` in the container to `superslicer-novnc-prints` locally on my machine, it will bind port `8080` to `8080`, and finally, it will provide an environment variable to keep Prusaslicer happy by providing an `SSL_CERT_FILE`.
**Using a VNC Viewer**
#### Docker Compose
To use the pre-built image, simply clone this repository or copy `docker-compose.yml` and run `docker compose up -d`.
To build a new image, clone this repository and run `docker compose up -f docker-compose.build.yml --build -d`
### Using a VNC Viewer
To use a VNC viewer with the container, the default port for X TigerVNC is 5900. You can add this port by adding `-p 5900:5900` to your command to start the container to open this port for access.
**GPU Acceleration/Passthrough**
### GPU Acceleration/Passthrough
Like other Docker containers, you can pass your Nvidia GPU into the container using the `NVIDIA_VISIBLE_DEVICES` and `NVIDIA_DRIVER_CAPABILITIES` envs. You can define these using the value of `all` or by providing more narrow and specific values. This has only been tested on Nvidia GPUs.
In unraid you can set these values during set up. For containers outside of unraid, you can set this by adding the following params or similar `-e NVIDIA_DRIVER_CAPABILITIES="all" NVIDIA_VISIBLE_DEVICES="all"`
In unraid you can set these values during set up. For containers outside of unraid, you can set this by adding the following params or similar `-e NVIDIA_DRIVER_CAPABILITIES="all" NVIDIA_VISIBLE_DEVICES="all"`. If using Docker Compose, uncomment the enviroment variables in the relevant docker-compose.yaml file.
## Links
@ -41,4 +47,4 @@ In unraid you can set these values during set up. For containers outside of unra
[Docker](https://hub.docker.com/r/mikeah/prusaslicer-novnc)
<a href="https://www.buymeacoffee.com/helfrichmichael" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
<a href="https://www.buymeacoffee.com/helfrichmichael" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>