https://github.com/openanalytics/shinyproxy-voila-demo
Running Voila apps in ShinyProxy
https://github.com/openanalytics/shinyproxy-voila-demo
containers dashboarding docker jupyter jupyter-notebook kubernetes shinyproxy
Last synced: 14 days ago
JSON representation
Running Voila apps in ShinyProxy
- Host: GitHub
- URL: https://github.com/openanalytics/shinyproxy-voila-demo
- Owner: openanalytics
- Created: 2023-08-14T12:59:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-21T13:58:12.000Z (over 1 year ago)
- Last Synced: 2024-05-21T15:18:18.416Z (over 1 year ago)
- Topics: containers, dashboarding, docker, jupyter, jupyter-notebook, kubernetes, shinyproxy
- Language: Jupyter Notebook
- Homepage: https://shinyproxy.io
- Size: 3.91 KB
- Stars: 1
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Running Voila apps in ShinyProxy
This repository describes how to add a Voila app inside ShinyProxy.
Voilà turns Jupyter notebooks into standalone web applications. For writing notebooks, checkout the [Jupyter Notebook demo](https://github.com/openanalytics/shinyproxy-jupyter-notebook-demo).
# Build the Docker image
To pull the image made in this repository from Docker Hub, use
```bash
sudo docker pull openanalytics/shinyproxy-voila-demo
```
the relevant Docker Hub repository can be found at https://hub.docker.com/r/openanalytics/shinyproxy-voila-demo
To build the image from the Dockerfile, clone this repository, then navigate to its root directory and run
```bash
sudo docker build -t openanalytics/shinyproxy-voila-demo .
```
# ShinyProxy Configuration
To add the Voila application to ShinyProxy add the following lines to its configuration file (see [application.yml](./application.yml) for a complete file):
```yaml
proxy:
specs:
- id: voila-demo
container-image: openanalytics/shinyproxy-voila-demo
port: 8080
container-cmd: ["voila", "basics.ipynb", "--no-browser", "--port=8080", "--base_url=#{proxy.getRuntimeValue('SHINYPROXY_PUBLIC_PATH')}", "--Voila.ip=0.0.0.0"]
target-path: "#{proxy.getRuntimeValue('SHINYPROXY_PUBLIC_PATH')}"
```
## References
* https://github.com/voila-dashboards/voila/blob/main/notebooks/basics.ipynb
**(c) Copyright Open Analytics NV, 2023.**