https://github.com/openanalytics/shinyproxy-config-examples
Configuration examples for ShinyProxy
https://github.com/openanalytics/shinyproxy-config-examples
containers docker docker-swarm kubernetes shinyproxy
Last synced: 14 days ago
JSON representation
Configuration examples for ShinyProxy
- Host: GitHub
- URL: https://github.com/openanalytics/shinyproxy-config-examples
- Owner: openanalytics
- Created: 2018-03-19T19:24:43.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2026-01-16T15:40:49.000Z (27 days ago)
- Last Synced: 2026-01-17T04:57:14.249Z (26 days ago)
- Topics: containers, docker, docker-swarm, kubernetes, shinyproxy
- Language: HTML
- Homepage: https://www.shinyproxy.io
- Size: 2.86 MB
- Stars: 159
- Watchers: 23
- Forks: 107
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - openanalytics/shinyproxy-config-examples - Configuration examples for ShinyProxy (HTML)
README
# ShinyProxy Configuration Examples
ShinyProxy can be configured to run in very different scenarios. Consider the following:
- For your first tryout, maybe you just want to use a single machine with a Java runtime and a docker daemon, and run `java -jar shinyproxy.jar`. And that's perfectly fine!
- But then you'd like to place ShinyProxy *inside* a container itself, because then you don't need to install a Java runtime on the host...
- And next up is a bigger deployment, where you can't rely on a single docker host but instead need a load-balanced cluster to guarantee enough containers are available for all your users.
- Not wanting to create a *single point of failure*, you also deploy multiple instances of ShinyProxy, load-balanced by a nginx front server.
As you can see, the configuration of ShinyProxy and its surrounding environment can quickly grow from trivial to not-so-trivial!
This repository offers some ready-to-use examples for various setups. Each example folder contains several configuration files, and an instructional README that explains how to go from a download to a running setup.
## Available examples
This repository contains examples that are divided by several categories, explained below.
### Standalone vs containerized
In a *standalone* setup, ShinyProxy runs as a Java process on the host. In a *containerized* setup, ShinyProxy runs inside a container.
### Docker engine vs docker swarm vs kubernetes
The term *Docker Engine* refers to a single, non-clustered docker installation. The engine is managed by a 'Docker daemon', a process that can be accessed by the `docker` commandline executable, by a HTTP URL or by a Unix socket.
*Docker swarm* is a layer that groups multiple docker installations in a 'swarm' that can offer clustering capabilities, including failover, load balancing, etc.
*Kubernetes* is a container orchestration service that can be used as an alternative to Docker Swarm. Several major cloud vendors such as Amazon and Google offer ready-to-use Kubernetes environments.
**Note: always use the [ShinyProxy Operator](https://github.com/openanalytics/shinyproxy-operator) for deploying ShinyProxy on Kubernetes.**
## Notes on the examples configuration
All examples use the `simple` authentication method, which defines two users:
- jack, an administrator, with the password 'password'
- jeff, a regular user, with the password 'password'
The demo applications all use the `openanalytics/shinyproxy-demo` image which
you can pull using
```bash
sudo docker pull openanalytics/shinyproxy-demo
```