docker-audacity/README.md

578 lines
31 KiB
Markdown
Raw Normal View History

2023-10-10 04:53:30 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read https://github.com/linuxserver/docker-audacity/blob/main/.github/CONTRIBUTING.md -->
2021-04-07 19:11:23 -04:00
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
[![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
2025-02-04 04:52:40 +00:00
[![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://linuxserver.io/discord "realtime support / chat with the community and the team.")
2021-04-07 19:11:23 -04:00
[![Discourse](https://img.shields.io/discourse/https/discourse.linuxserver.io/topics.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=discourse)](https://discourse.linuxserver.io "post on our community forum.")
[![GitHub](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub&logo=github)](https://github.com/linuxserver "view the source for all of our repositories.")
[![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Supporters&logo=open%20collective)](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget")
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:
2021-04-17 14:28:51 -04:00
* regular and timely application updates
* easy user mappings (PGID, PUID)
* custom base image with s6 overlay
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
* regular security updates
2021-04-07 19:11:23 -04:00
Find us at:
2021-04-17 14:28:51 -04:00
2021-04-07 19:11:23 -04:00
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
2025-02-04 04:52:40 +00:00
* [Discord](https://linuxserver.io/discord) - realtime support / chat with the community and the team.
2021-04-07 19:11:23 -04:00
* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
* [GitHub](https://github.com/linuxserver) - view the source for all of our repositories.
* [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget
# [linuxserver/audacity](https://github.com/linuxserver/docker-audacity)
2024-05-21 04:53:39 +00:00
[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Faudacity?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh)
2021-04-07 19:11:23 -04:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-audacity.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-audacity)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-audacity.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-audacity/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-audacity/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-audacity/container_registry)
2021-10-04 14:32:46 +02:00
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/audacity)
2021-04-07 19:11:23 -04:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/audacity.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/audacity)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/audacity.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/audacity)
2021-04-07 20:33:22 -04:00
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-audacity%2Fjob%2Fmain%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-audacity/job/main/)
2021-04-07 19:11:23 -04:00
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Faudacity%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/audacity/latest/index.html)
[Audacity](https://www.audacityteam.org/) is an easy-to-use, multi-track audio editor and recorder. Developed by a group of volunteers as open source.
[![audacity](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/audacity-logo.png)](https://www.audacityteam.org/)
## Supported Architectures
2023-11-16 15:42:46 +00:00
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2021-04-07 19:11:23 -04:00
2022-05-02 07:44:26 -05:00
Simply pulling `lscr.io/linuxserver/audacity:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2021-04-07 19:11:23 -04:00
The architectures supported by this image are:
2022-05-02 07:44:26 -05:00
| Architecture | Available | Tag |
| :----: | :----: | ---- |
| x86-64 | ✅ | amd64-\<version tag\> |
| arm64 | ❌ | |
2021-04-07 19:11:23 -04:00
2021-04-17 14:28:51 -04:00
## Application Setup
The application can be accessed at:
2023-03-19 15:07:04 -07:00
* https://yourhost:3001/
2021-04-17 14:28:51 -04:00
2025-07-19 14:40:36 -04:00
### Strict reverse proxies
This image uses a self-signed certificate by default. This naturally means the scheme is `https`.
If you are using a reverse proxy which validates certificates, you need to [disable this check for the container](https://docs.linuxserver.io/faq#strict-proxy).
**Modern GUI desktop apps may have compatibility issues with the latest Docker syscall restrictions. You can use Docker with the `--security-opt seccomp=unconfined` setting to allow these syscalls on hosts with older Kernels or libseccomp versions.**
2024-11-09 15:21:39 -05:00
### Security
>[!WARNING]
2025-07-19 14:40:36 -04:00
>This container provides privileged access to the host system. Do not expose it to the Internet unless you have secured it properly.
2024-11-09 15:21:39 -05:00
2025-07-19 14:40:36 -04:00
**HTTPS is required for full functionality.** Modern browser features such as WebCodecs, used for video and audio, will not function over an insecure HTTP connection.
2024-11-09 15:21:39 -05:00
2025-07-19 14:40:36 -04:00
By default, this container has no authentication. The optional `CUSTOM_USER` and `PASSWORD` environment variables enable basic HTTP auth, which is suitable only for securing the container on a trusted local network. For internet exposure, we strongly recommend placing the container behind a reverse proxy, such as [SWAG](https://github.com/linuxserver/docker-swag), with a robust authentication mechanism.
2021-04-17 14:28:51 -04:00
2025-07-19 14:40:36 -04:00
The web interface includes a terminal with passwordless `sudo` access. Any user with access to the GUI can gain root control within the container, install arbitrary software, and probe your local network.
2023-03-19 15:07:04 -07:00
2025-09-23 04:52:17 +00:00
While not generally recommended, certain legacy environments specifically those with older hardware or outdated Linux distributions may require the deactivation of the standard seccomp profile to get containerized desktop software to run. This can be achieved by utilizing the `--security-opt seccomp=unconfined` parameter. It is critical to use this option only when absolutely necessary as it disables a key security layer of Docker, elevating the potential for container escape vulnerabilities.
2025-07-19 14:40:36 -04:00
### Options in all Selkies-based GUI containers
2023-03-19 15:07:04 -07:00
2025-07-19 14:40:36 -04:00
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies), which provides the following environment variables and run configurations to customize its functionality.
#### Optional Environment Variables
2023-03-19 15:07:04 -07:00
| Variable | Description |
| :----: | --- |
2025-10-21 04:54:11 +00:00
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default `3000` |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default `3001` |
| CUSTOM_WS_PORT | Internal port the container listens on for websockets if it needs to be swapped from the default 8082 |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| DRI_NODE | Enable VAAPI stream encoding and use the specified device IE `/dev/dri/renderD128` |
| DRINODE | Specify which GPU to use for DRI3 acceleration IE `/dev/dri/renderD129` |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
| TITLE | The page title displayed on the web browser, default "Selkies" |
| DASHBOARD | Allows the user to set their dashboard. Options: `selkies-dashboard`, `selkies-dashboard-zinc`, `selkies-dashboard-wish` |
| FILE_MANAGER_PATH | Modifies the default upload/download file path, path must have proper permissions for abc user |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup |
| DISABLE_IPV6 | If set to true or any value this will disable IPv6 |
| LC_ALL | Set the Language for the container to run as IE `fr_FR.UTF-8` `ar_AE.UTF-8` |
| NO_DECOR | If set the application will run without window borders for use as a PWA. (Decor can be enabled and disabled with Ctrl+Shift+d) |
| NO_FULL | Do not autmatically fullscreen applications when using openbox. |
| NO_GAMEPAD | Disable userspace gamepad interposer injection. |
| DISABLE_ZINK | Do not set the Zink environment variables if a video card is detected (userspace applications will use CPU rendering) |
| DISABLE_DRI3 | Do not use DRI3 acceleration if a video card is detected (userspace applications will use CPU rendering) |
| MAX_RES | Pass a larger maximum resolution for the container default is 16k `15360x8640` |
| WATERMARK_PNG | Full path inside the container to a watermark png IE `/usr/share/selkies/www/icon.png` |
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
**`WATERMARK_LOCATION` Options:**
- **1**: Top Left
- **2**: Top Right
- **3**: Bottom Left
- **4**: Bottom Right
- **5**: Centered
- **6**: Animated
2025-07-19 14:40:36 -04:00
#### Optional Run Configurations
| Argument | Description |
| :----: | --- |
| `--privileged` | Starts a Docker-in-Docker (DinD) environment. For better performance, mount the Docker data directory from the host, e.g., `-v /path/to/docker-data:/var/lib/docker`. |
| `-v /var/run/docker.sock:/var/run/docker.sock` | Mounts the host's Docker socket to manage host containers from within this container. |
2024-11-09 15:21:39 -05:00
| `--device /dev/dri:/dev/dri` | Mount a GPU into the container, this can be used in conjunction with the `DRINODE` environment variable to leverage a host video card for GPU accelerated applications. Only **Open Source** drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
2023-03-19 15:07:04 -07:00
### Language Support - Internationalization
2025-07-19 14:40:36 -04:00
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
2025-07-19 14:40:36 -04:00
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
* `-e LC_ALL=ko_KR.UTF-8` - Korean
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
* `-e LC_ALL=ru_RU.UTF-8` - Russian
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
* `-e LC_ALL=de_DE.UTF-8` - German
* `-e LC_ALL=fr_FR.UTF-8` - French
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
* `-e LC_ALL=it_IT.UTF-8` - Italian
2025-07-19 14:40:36 -04:00
### DRI3 GPU Acceleration
2024-11-09 15:21:39 -05:00
For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using:
`--device /dev/dri:/dev/dri`
This feature only supports **Open Source** GPU drivers:
| Driver | Description |
| :----: | --- |
| Intel | i965 and i915 drivers for Intel iGPU chipsets |
| AMD | AMDGPU, Radeon, and ATI drivers for AMD dedicated or APU chipsets |
| NVIDIA | nouveau2 drivers only, closed source NVIDIA drivers lack DRI3 support |
The `DRINODE` environment variable can be used to point to a specific GPU.
2025-07-19 14:40:36 -04:00
DRI3 will work on aarch64 given the correct drivers are installed inside the container for your chipset.
2024-11-09 15:21:39 -05:00
2025-07-19 14:40:36 -04:00
### Nvidia GPU Support
2024-11-09 15:21:39 -05:00
2025-07-19 14:40:36 -04:00
**Note: Nvidia support is not available for Alpine-based images.**
2024-11-09 15:21:39 -05:00
2025-07-19 14:40:36 -04:00
Nvidia GPU support is available by leveraging Zink for OpenGL. When a compatible Nvidia GPU is passed through, it will also be **automatically utilized for hardware-accelerated video stream encoding** (using the `x264enc` full-frame profile), significantly reducing CPU load.
Enable Nvidia support with the following runtime flags:
| Flag | Description |
2024-11-09 15:21:39 -05:00
| :----: | --- |
2025-07-19 14:40:36 -04:00
| `--gpus all` | Passes all available host GPUs to the container. This can be filtered to specific GPUs. |
| `--runtime nvidia` | Specifies the Nvidia runtime, which provides the necessary drivers and tools from the host. |
2024-11-09 15:21:39 -05:00
2025-07-19 14:40:36 -04:00
For Docker Compose, you must first configure the Nvidia runtime as the default on the host:
2024-11-09 15:21:39 -05:00
```
sudo nvidia-ctk runtime configure --runtime=docker --set-as-default
2025-07-19 14:40:36 -04:00
sudo systemctl restart docker
2024-11-09 15:21:39 -05:00
```
2025-07-19 14:40:36 -04:00
Then, assign the GPU to the service in your `compose.yaml`:
2024-11-09 15:21:39 -05:00
```
services:
audacity:
image: lscr.io/linuxserver/audacity:latest
deploy:
resources:
reservations:
devices:
- driver: nvidia
count: 1
capabilities: [compute,video,graphics,utility]
```
2025-07-19 14:40:36 -04:00
### Application Management
There are two methods for installing applications inside the container: PRoot Apps (recommended for persistence) and Native Apps.
#### PRoot Apps (Persistent)
2024-11-09 15:21:39 -05:00
2025-07-19 14:40:36 -04:00
Natively installed packages (e.g., via `apt-get install`) will not persist if the container is recreated. To retain applications and their settings across container updates, we recommend using [proot-apps](https://github.com/linuxserver/proot-apps). These are portable applications installed to the user's persistent `$HOME` directory.
2024-11-09 15:21:39 -05:00
2025-07-19 14:40:36 -04:00
To install an application, use the command line inside the container:
2024-11-09 15:21:39 -05:00
```
proot-apps install filezilla
```
2025-07-19 14:40:36 -04:00
A list of supported applications is available [here](https://github.com/linuxserver/proot-apps?tab=readme-ov-file#supported-apps).
2024-11-09 15:21:39 -05:00
2025-07-19 14:40:36 -04:00
#### Native Apps (Non-Persistent)
2024-11-09 15:21:39 -05:00
2025-07-19 14:40:36 -04:00
You can install packages from the system's native repository using the [universal-package-install](https://github.com/linuxserver/docker-mods/tree/universal-package-install) mod. This method will increase the container's start time and is not persistent. Add the following to your `compose.yaml`:
2024-11-09 15:21:39 -05:00
```yaml
environment:
- DOCKER_MODS=linuxserver/mods:universal-package-install
- INSTALL_PACKAGES=libfuse2|git|gdb
```
2025-10-21 04:54:11 +00:00
#### Hardening
These variables can be used to lock down the desktop environment for single-application use cases or to restrict user capabilities.
##### Meta Variables
These variables act as presets, enabling multiple hardening options at once. Individual options can still be set to override the preset.
| Variable | Description |
| :----: | --- |
| **`HARDEN_DESKTOP`** | Enables `DISABLE_OPEN_TOOLS`, `DISABLE_SUDO`, and `DISABLE_TERMINALS`. Also sets related Selkies UI settings (`SELKIES_FILE_TRANSFERS`, `SELKIES_COMMAND_ENABLED`, `SELKIES_UI_SIDEBAR_SHOW_FILES`, `SELKIES_UI_SIDEBAR_SHOW_APPS`) if they are not explicitly set by the user. |
| **`HARDEN_OPENBOX`** | Enables `DISABLE_CLOSE_BUTTON`, `DISABLE_MOUSE_BUTTONS`, and `HARDEN_KEYBINDS`. It also flags `RESTART_APP` if not set by the user, ensuring the primary application is automatically restarted if closed. |
##### Individual Hardening Variables
| Variable | Description |
| :--- | --- |
| **`DISABLE_OPEN_TOOLS`** | If true, disables `xdg-open` and `exo-open` binaries by removing their execute permissions. |
| **`DISABLE_SUDO`** | If true, disables the `sudo` command by removing its execute permissions and invalidating the passwordless sudo configuration. |
| **`DISABLE_TERMINALS`** | If true, disables common terminal emulators by removing their execute permissions and hiding them from the Openbox right-click menu. |
| **`DISABLE_CLOSE_BUTTON`** | If true, removes the close button from window title bars in the Openbox window manager. |
| **`DISABLE_MOUSE_BUTTONS`** | If true, disables the right-click and middle-click context menus and actions within the Openbox window manager. |
| **`HARDEN_KEYBINDS`** | If true, disables default Openbox keybinds that can bypass other hardening options (e.g., `Alt+F4` to close windows, `Alt+Escape` to show the root menu). |
| **`RESTART_APP`** | If true, enables a watchdog service that automatically restarts the main application if it is closed. The user's autostart script is made read-only and root owned to prevent tampering. |
#### Selkies application settings
Using environment variables every facet of the application can be configured.
##### Booleans and Locking
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`. The UI toggle for this setting will be hidden.
* **Example**: To force CPU encoding on and prevent the user from disabling it:
```bash
-e SELKIES_USE_CPU="true|locked"
```
##### Enums and Lists
These settings accept a comma-separated list of values. Their behavior depends on the number of items provided:
* **Multiple Values**: The first item in the list becomes the default selection, and all items in the list become the available options in the UI dropdown.
* **Single Value**: The provided value becomes the default, and the UI dropdown is hidden because the choice is locked.
* **Example**: Force the encoder to be `jpeg` with no other options available to the user:
```bash
-e SELKIES_ENCODER="jpeg"
```
##### Ranges
Range settings define a minimum and maximum for a value (e.g., framerate).
* **To set a range**: Use a hyphen-separated `min-max` format. The UI will show a slider.
* **To set a fixed value**: Provide a single number. This will lock the value and hide the UI slider.
* **Example**: Lock the framerate to exactly 60 FPS.
```bash
-e SELKIES_FRAMERATE="60"
```
##### Manual Resolution Mode
The server can be forced to use a single, fixed resolution for all connecting clients. This mode is automatically activated if `SELKIES_MANUAL_WIDTH`, `SELKIES_MANUAL_HEIGHT`, or `SELKIES_IS_MANUAL_RESOLUTION_MODE` is set.
* If `SELKIES_MANUAL_WIDTH` and/or `SELKIES_MANUAL_HEIGHT` are set, the resolution is locked to those values.
* If `SELKIES_IS_MANUAL_RESOLUTION_MODE` is set to `true` without specifying width or height, the resolution defaults to **1024x768**.
* When this mode is active, the client UI for changing resolution is disabled.
| Environment Variable | Default Value | Description |
| --- | --- | --- |
| `SELKIES_UI_TITLE` | `'Selkies'` | Title in top left corner of sidebar. |
| `SELKIES_UI_SHOW_LOGO` | `True` | Show the Selkies logo in the sidebar. |
| `SELKIES_UI_SHOW_SIDEBAR` | `True` | Show the main sidebar UI. |
| `SELKIES_UI_SHOW_CORE_BUTTONS` | `True` | Show the core components buttons display, audio, microphone, and gamepad. |
| `SELKIES_UI_SIDEBAR_SHOW_VIDEO_SETTINGS` | `True` | Show the video settings section in the sidebar. |
| `SELKIES_UI_SIDEBAR_SHOW_SCREEN_SETTINGS` | `True` | Show the screen settings section in the sidebar. |
| `SELKIES_UI_SIDEBAR_SHOW_AUDIO_SETTINGS` | `True` | Show the audio settings section in the sidebar. |
| `SELKIES_UI_SIDEBAR_SHOW_STATS` | `True` | Show the stats section in the sidebar. |
| `SELKIES_UI_SIDEBAR_SHOW_CLIPBOARD` | `True` | Show the clipboard section in the sidebar. |
| `SELKIES_UI_SIDEBAR_SHOW_FILES` | `True` | Show the file transfer section in the sidebar. |
| `SELKIES_UI_SIDEBAR_SHOW_APPS` | `True` | Show the applications section in the sidebar. |
| `SELKIES_UI_SIDEBAR_SHOW_SHARING` | `True` | Show the sharing section in the sidebar. |
| `SELKIES_UI_SIDEBAR_SHOW_GAMEPADS` | `True` | Show the gamepads section in the sidebar. |
| `SELKIES_UI_SIDEBAR_SHOW_FULLSCREEN` | `True` | Show the fullscreen button in the sidebar. |
| `SELKIES_UI_SIDEBAR_SHOW_GAMING_MODE` | `True` | Show the gaming mode button in the sidebar. |
| `SELKIES_UI_SIDEBAR_SHOW_TRACKPAD` | `True` | Show the virtual trackpad button in the sidebar. |
| `SELKIES_UI_SIDEBAR_SHOW_KEYBOARD_BUTTON` | `True` | Show the on-screen keyboard button in the display area. |
| `SELKIES_UI_SIDEBAR_SHOW_SOFT_BUTTONS` | `True` | Show the soft buttons section in the sidebar. |
| `SELKIES_AUDIO_ENABLED` | `True` | Enable server-to-client audio streaming. |
| `SELKIES_MICROPHONE_ENABLED` | `True` | Enable client-to-server microphone forwarding. |
| `SELKIES_GAMEPAD_ENABLED` | `True` | Enable gamepad support. |
| `SELKIES_CLIPBOARD_ENABLED` | `True` | Enable clipboard synchronization. |
| `SELKIES_COMMAND_ENABLED` | `True` | Enable parsing of command websocket messages. |
| `SELKIES_FILE_TRANSFERS` | `'upload,download'` | Allowed file transfer directions (comma-separated: "upload,download"). Set to "" or "none" to disable. |
| `SELKIES_ENCODER` | `'x264enc,x264enc-striped,jpeg'` | The default video encoders. |
| `SELKIES_FRAMERATE` | `'8-120'` | Allowed framerate range or a fixed value. |
| `SELKIES_H264_CRF` | `'5-50'` | Allowed H.264 CRF range or a fixed value. |
| `SELKIES_JPEG_QUALITY` | `'1-100'` | Allowed JPEG quality range or a fixed value. |
| `SELKIES_H264_FULLCOLOR` | `False` | Enable H.264 full color range for pixelflux encoders. |
| `SELKIES_H264_STREAMING_MODE` | `False` | Enable H.264 streaming mode for pixelflux encoders. |
| `SELKIES_USE_CPU` | `False` | Force CPU-based encoding for pixelflux. |
| `SELKIES_USE_PAINT_OVER_QUALITY` | `True` | Enable high-quality paint-over for static scenes. |
| `SELKIES_PAINT_OVER_JPEG_QUALITY` | `'1-100'` | Allowed JPEG paint-over quality range or a fixed value. |
| `SELKIES_H264_PAINTOVER_CRF` | `'5-50'` | Allowed H.264 paint-over CRF range or a fixed value. |
| `SELKIES_H264_PAINTOVER_BURST_FRAMES` | `'1-30'` | Allowed H.264 paint-over burst frames range or a fixed value. |
| `SELKIES_SECOND_SCREEN` | `True` | Enable support for a second monitor/display. |
| `SELKIES_AUDIO_BITRATE` | `'320000'` | The default audio bitrate. |
| `SELKIES_IS_MANUAL_RESOLUTION_MODE` | `False` | Lock the resolution to the manual width/height values. |
| `SELKIES_MANUAL_WIDTH` | `0` | Lock width to a fixed value. Setting this forces manual resolution mode. |
| `SELKIES_MANUAL_HEIGHT` | `0` | Lock height to a fixed value. Setting this forces manual resolution mode. |
| `SELKIES_SCALING_DPI` | `'96'` | The default DPI for UI scaling. |
| `SELKIES_ENABLE_BINARY_CLIPBOARD` | `False` | Allow binary data on the clipboard. |
| `SELKIES_USE_BROWSER_CURSORS` | `False` | Use browser CSS cursors instead of rendering to canvas. |
| `SELKIES_USE_CSS_SCALING` | `False` | HiDPI when false, if true a lower resolution is sent from the client and the canvas is stretched. |
| `SELKIES_PORT` (or `CUSTOM_WS_PORT`) | `8082` | Port for the data websocket server. |
| `SELKIES_DRI_NODE` (or `DRI_NODE`) | `''` | Path to the DRI render node for VA-API. |
| `SELKIES_AUDIO_DEVICE_NAME` | `'output.monitor'` | Audio device name for pcmflux capture. |
| `SELKIES_WATERMARK_PATH` (or `WATERMARK_PNG`) | `''` | Absolute path to the watermark PNG file. |
| `SELKIES_WATERMARK_LOCATION` (or `WATERMARK_LOCATION`) | `-1` | Watermark location enum (0-6). |
| `SELKIES_DEBUG` | `False` | Enable debug logging. |
| `SELKIES_ENABLE_SHARING` | `True` | Master toggle for all sharing features. |
| `SELKIES_ENABLE_COLLAB` | `True` | Enable collaborative (read-write) sharing link. |
| `SELKIES_ENABLE_SHARED` | `True` | Enable view-only sharing links. |
| `SELKIES_ENABLE_PLAYER2` | `True` | Enable sharing link for gamepad player 2. |
| `SELKIES_ENABLE_PLAYER3` | `True` | Enable sharing link for gamepad player 3. |
| `SELKIES_ENABLE_PLAYER4` | `True` | Enable sharing link for gamepad player 4. |
2021-04-07 19:11:23 -04:00
## Usage
2023-10-10 04:53:30 +00:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2021-04-07 19:11:23 -04:00
2024-12-03 04:56:11 +00:00
>[!NOTE]
>Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.
2021-07-05 08:32:05 -04:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2021-04-07 19:11:23 -04:00
```yaml
---
services:
audacity:
2022-05-02 07:44:26 -05:00
image: lscr.io/linuxserver/audacity:latest
2021-04-07 19:11:23 -04:00
container_name: audacity
environment:
- PUID=1000
- PGID=1000
2023-02-13 06:39:58 -06:00
- TZ=Etc/UTC
2021-04-07 19:11:23 -04:00
volumes:
2024-08-19 15:31:14 -04:00
- /path/to/audacity/config:/config
2021-04-07 19:11:23 -04:00
ports:
- 3000:3000
2023-03-19 15:07:04 -07:00
- 3001:3001
2025-09-23 12:08:39 -04:00
shm_size: "1gb"
2021-04-07 19:11:23 -04:00
restart: unless-stopped
```
2021-07-05 08:32:05 -04:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2021-04-07 19:11:23 -04:00
2021-04-17 14:28:51 -04:00
```bash
2021-04-07 19:11:23 -04:00
docker run -d \
--name=audacity \
-e PUID=1000 \
-e PGID=1000 \
2023-02-13 06:39:58 -06:00
-e TZ=Etc/UTC \
2021-04-07 19:11:23 -04:00
-p 3000:3000 \
2023-03-19 15:07:04 -07:00
-p 3001:3001 \
2024-08-19 15:31:14 -04:00
-v /path/to/audacity/config:/config \
2025-09-23 12:08:39 -04:00
--shm-size="1gb" \
2021-04-07 19:11:23 -04:00
--restart unless-stopped \
2022-05-02 07:44:26 -05:00
lscr.io/linuxserver/audacity:latest
2021-04-07 19:11:23 -04:00
```
## Parameters
2023-10-10 04:53:30 +00:00
Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
2021-04-07 19:11:23 -04:00
| Parameter | Function |
| :----: | --- |
2025-07-19 14:40:36 -04:00
| `-p 3000:3000` | Audacity desktop gui HTTP, must be proxied. |
2024-12-03 04:56:11 +00:00
| `-p 3001:3001` | Audacity desktop gui HTTPS. |
2021-04-07 19:11:23 -04:00
| `-e PUID=1000` | for UserID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation |
2023-02-13 06:39:58 -06:00
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
2021-04-07 19:11:23 -04:00
| `-v /config` | Users home directory in the container, stores program settings and images |
2025-09-23 12:08:39 -04:00
| `--shm-size=` | Recommended for all desktop images. |
2021-04-07 19:11:23 -04:00
## Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
2021-04-17 14:28:51 -04:00
```bash
2023-10-10 04:53:30 +00:00
-e FILE__MYVAR=/run/secrets/mysecretvariable
2021-04-07 19:11:23 -04:00
```
2023-10-10 04:53:30 +00:00
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
2021-04-07 19:11:23 -04:00
## Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
## User / Group Identifiers
2023-10-10 04:53:30 +00:00
When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
2021-04-07 19:11:23 -04:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2023-10-10 04:53:30 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
2021-04-07 19:11:23 -04:00
2021-04-17 14:28:51 -04:00
```bash
2023-10-10 04:53:30 +00:00
id your_user
```
Example output:
```text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
2021-04-07 19:11:23 -04:00
```
## Docker Mods
2021-04-17 14:28:51 -04:00
2021-04-07 19:11:23 -04:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=audacity&query=%24.mods%5B%27audacity%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=audacity "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
## Support Info
2023-10-10 04:53:30 +00:00
* Shell access whilst the container is running:
```bash
docker exec -it audacity /bin/bash
```
* To monitor the logs of the container in realtime:
```bash
docker logs -f audacity
```
* Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' audacity
```
* Image version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/audacity:latest
```
2021-04-07 19:11:23 -04:00
## Updating Info
2024-01-16 04:54:56 +00:00
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
2021-04-07 19:11:23 -04:00
Below are the instructions for updating containers:
### Via Docker Compose
2021-04-17 14:28:51 -04:00
2023-10-10 04:53:30 +00:00
* Update images:
* All images:
```bash
docker-compose pull
```
* Single image:
```bash
docker-compose pull audacity
```
* Update containers:
* All containers:
```bash
docker-compose up -d
```
* Single container:
```bash
docker-compose up -d audacity
```
* You can also remove the old dangling images:
```bash
docker image prune
```
2021-04-07 19:11:23 -04:00
### Via Docker Run
2021-04-17 14:28:51 -04:00
2023-10-10 04:53:30 +00:00
* Update the image:
```bash
docker pull lscr.io/linuxserver/audacity:latest
```
* Stop the running container:
```bash
docker stop audacity
```
* Delete the container:
```bash
docker rm audacity
```
2021-04-07 19:11:23 -04:00
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
2023-10-10 04:53:30 +00:00
* You can also remove the old dangling images:
```bash
docker image prune
```
2021-04-07 19:11:23 -04:00
### Image Update Notifications - Diun (Docker Image Update Notifier)
2021-04-17 14:28:51 -04:00
2024-10-01 04:54:40 +00:00
>[!TIP]
>We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
2021-04-07 19:11:23 -04:00
## Building locally
If you want to make local modifications to these images for development purposes or just to customize the logic:
2021-04-17 14:28:51 -04:00
```bash
2021-04-07 19:11:23 -04:00
git clone https://github.com/linuxserver/docker-audacity.git
cd docker-audacity
docker build \
--no-cache \
--pull \
2021-10-04 14:32:46 +02:00
-t lscr.io/linuxserver/audacity:latest .
2021-04-07 19:11:23 -04:00
```
2024-11-09 15:21:39 -05:00
The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static`
2021-04-17 14:28:51 -04:00
```bash
2024-11-09 15:21:39 -05:00
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
2021-04-07 19:11:23 -04:00
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
## Versions
2025-07-19 14:40:36 -04:00
* **12.07.25:** - Rebase to Selkies, HTTPS IS NOW REQUIRED.
2024-10-31 13:01:32 +01:00
* **31.10.24:** - Fix artifact name.
2024-08-19 15:31:14 -04:00
* **19.08.24:** - Rebase to noble.
* **10.02.24:** - Update Readme with new env vars, ingest proper PWA icon, and pre-extract appimage.
2023-05-05 21:12:24 +00:00
* **05.05.23:** - Start Audacity in full screen.
2023-03-19 15:07:04 -07:00
* **18.03.23:** - Rebase to KasmVNC base image.
2022-12-13 18:49:14 +00:00
* **13.12.22:** - Rebase to Jammy.
2021-07-26 13:22:59 -04:00
* **14.09.21:** - Use the official appimage, switch to single arch (x86_64). Armhf and aarch64 users can remain on version 3.0.2 but there won't be further updates.
2021-04-07 19:11:23 -04:00
* **07.04.21:** - Initial release.