mirror of
https://github.com/linuxserver/docker-suyu.git
synced 2026-01-09 11:52:45 +08:00
83 lines
3.4 KiB
YAML
83 lines
3.4 KiB
YAML
---
|
|
|
|
# project information
|
|
project_name: suyu
|
|
project_url: "https://suyu.dev/"
|
|
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/suyu-logo.png"
|
|
project_blurb: "[suyu]({{ project_url }}) is an open-source emulator"
|
|
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
|
|
project_blurb_optional_extras_enabled: false
|
|
# supported architectures
|
|
available_architectures:
|
|
- {arch: "{{ arch_x86_64 }}", tag: "latest"}
|
|
# development version
|
|
development_versions: false
|
|
# container parameters
|
|
common_param_env_vars_enabled: true
|
|
param_container_name: "{{ project_name }}"
|
|
param_usage_include_env: true
|
|
param_env_vars:
|
|
- {env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London."}
|
|
param_usage_include_vols: true
|
|
param_volumes:
|
|
- {vol_path: "/config", vol_host_path: "/path/to/config", desc: "Users home directory in the container, stores local files and settings"}
|
|
param_usage_include_ports: true
|
|
param_ports:
|
|
- {external_port: "3000", internal_port: "3000", port_desc: "HTTP Suyu desktop gui must be proxied."}
|
|
- {external_port: "3001", internal_port: "3001", port_desc: "HTTPS Suyu desktop gui."}
|
|
# optional variables
|
|
opt_security_opt_param: true
|
|
opt_security_opt_param_vars:
|
|
- {run_var: "seccomp=unconfined", compose_var: "seccomp:unconfined", desc: "For Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker."}
|
|
# application setup block
|
|
app_setup_block_enabled: true
|
|
app_setup_block: |
|
|
The application can be accessed at:
|
|
|
|
* https://yourhost:3001/
|
|
|
|
|
|
### Security
|
|
|
|
>[!WARNING]
|
|
>Do not put this on the Internet if you do not know what you are doing.
|
|
|
|
By default this container has no authentication and the optional environment variables `CUSTOM_USER` and `PASSWORD` to enable basic http auth via the embedded NGINX server should only be used to locally secure the container from unwanted access on a local network. If exposing this to the Internet we recommend putting it behind a reverse proxy, such as [SWAG](https://github.com/linuxserver/docker-swag), and ensuring a secure authentication solution is in place. From the web interface a terminal can be launched and it is configured for passwordless sudo, so anyone with access to it can install and run whatever they want along with probing your local network.
|
|
|
|
### Nvidia GPU Support
|
|
|
|
**Nvidia support is not compatible with Alpine based images as Alpine lacks Nvidia drivers**
|
|
|
|
Nvidia support is available by leveraging Zink for OpenGL support. This can be enabled with the following run flags:
|
|
|
|
| Variable | Description |
|
|
| :----: | --- |
|
|
| --gpus all | This can be filtered down but for most setups this will pass the one Nvidia GPU on the system |
|
|
| --runtime nvidia | Specify the Nvidia runtime which mounts drivers and tools in from the host |
|
|
|
|
The compose syntax is slightly different for this as you will need to set nvidia as the default runtime:
|
|
|
|
```
|
|
sudo nvidia-ctk runtime configure --runtime=docker --set-as-default
|
|
sudo service docker restart
|
|
```
|
|
|
|
And to assign the GPU in compose:
|
|
|
|
```
|
|
services:
|
|
webtop:
|
|
image: lscr.io/linuxserver/suyu:latest
|
|
deploy:
|
|
resources:
|
|
reservations:
|
|
devices:
|
|
- driver: nvidia
|
|
count: 1
|
|
capabilities: [compute,video,graphics,utility]
|
|
```
|
|
|
|
# changelog
|
|
changelogs:
|
|
- {date: "18.06.25:", desc: "Initial release."}
|