mirror of
https://github.com/helfrichmichael/prusaslicer-novnc.git
synced 2024-08-30 18:32:27 +00:00
66 lines
4.0 KiB
Markdown
66 lines
4.0 KiB
Markdown
# Prusaslicer noVNC Docker Container
|
|
|
|
## Overview
|
|
|
|
This is a super basic noVNC build using supervisor to serve Prusaslicer in your favorite web browser. This was primarily built for users using the [popular unraid NAS software](https://unraid.net), to allow them to quickly hop in a browser, slice, and upload their favorite 3D prints.
|
|
|
|
A lot of this was branched off of dmagyar's awesome [prusaslicer-vnc-docker](https://hub.docker.com/r/dmagyar/prusaslicer-vnc-docker/) project, but I found it to be a bit complex for my needs and thought this approach would simplify things a lot.
|
|
|
|
## How to use
|
|
|
|
### 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
|
|
|
|
#### 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`.
|
|
|
|
#### 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
|
|
|
|
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"`. If using Docker Compose, uncomment the enviroment variables in the relevant docker-compose.yaml file.
|
|
|
|
In addtion to the above, to enable HW 3D acceleration (helps with complex models and visualizing the sliced layers), you must pass ane environment variable by adding a `-e ENABLEHWGPU=true` to the docker run command or adding `- ENABLEHWGPU=true` to your docker compose.
|
|
|
|
### Other Environment Variables
|
|
|
|
Default values shown below.
|
|
|
|
- `DISPLAY=:0` sets the DISPLAY variable, this can be left as 0
|
|
- `VGL_DISPLAY=egl` needed for HW 3D accelration with EGL support on the HOST graphics driver.
|
|
- `SUPD_LOGLEVEL=INFO` log level for supervisord
|
|
- `ENABLEHWGPU=true` enable HW 3D Accelaration
|
|
- `VNC_RESOLUTION=1280x800` resolution of the VNC server
|
|
- `VNC_PASSWORD=(None)` defaults to no VNC password, you can add one here.
|
|
- `NOVNC_PORT=8080` port for the novonc HTML5/web interface.
|
|
- `VNC_PORT=5900` port fo the vnc server, allows direct connections using a VNC client. Note the `DISPLAY` number above is added to the port number, so if your display is :1 then VNC port accepting connections will be `5901`
|
|
|
|
|
|
## Links
|
|
|
|
[Prusaslicer](https://www.prusa3d.com/prusaslicer/)
|
|
|
|
[Supervisor](http://supervisord.org/)
|
|
|
|
[GitHub Source](https://github.com/helfrichmichael/prusaslicer-novnc)
|
|
|
|
[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>
|