mirror of https://github.com/m1k1o/neko.git synced 2025-04-29 02:16:21 +02:00

Miroslav Šedivý e3cdad3f81 update docs.

2025-03-22 18:53:45 +01:00

11 KiB

Raw Blame History

sidebar_position
1

Docker Images

Neko as a standalone streaming server is available as a Docker image. But that is rarely interesting for general use. The real power of Neko is in its ability to accommodate custom applications in the virtual desktop environment. This is where the various flavors of Neko Docker images come in.

The base image is available at ghcr.io/m1k1o/neko/base.

Naming Convention

Neko Docker images are available on GitHub Container Registry (GHCR). The naming convention for Neko Docker images is as follows:

ghcr.io/m1k1o/neko/[<flavor>-]<application>:<version>

<flavor> is the optional flavor of the image, see Available Flavors for more information.
<application> is the application name or base image, see Available Applications for more information.
<version> is the semantic version of the image from the GitHub tags. There is always a latest tag available.

An alternative registry is also available on Docker Hub, however, only images without flavor and with the latest version are available there.

m1k1o/neko:<application>

:::info You should always prefer the GHCR registry with the ability to use flavors and specific versions. :::

Available Applications

The following applications are available as Neko Docker images:

Firefox-based browsers

In comparison to Chromium-based browsers, Firefox-based browsers do not require additional capabilities or a bigger shared memory size to not crash.

Icon	Name	Docker Image
	Firefox The open-source browser from Mozilla.	`ghcr.io/m1k1o/neko/firefox`
	Tor Browser A browser designed to access the Tor network for enhanced privacy.	`ghcr.io/m1k1o/neko/tor-browser`
	Waterfox A privacy-focused browser based on Firefox.	`ghcr.io/m1k1o/neko/waterfox`

Chromium-based browsers

There are multiple flavors of Chromium-based browsers available as Neko Docker images.

They need --cap-add=SYS_ADMIN (see security implications for more information) and extended shared memory size (--shm-size=2g) to work properly.

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

```bash
docker run \
  --cap-add=SYS_ADMIN \
  --shm-size=2g \
  ghcr.io/m1k1o/neko/chromium
```

```yaml title="docker-compose.yaml"
cap_add:
- SYS_ADMIN
shm_size: 2g
```

Icon	Name	Docker Image
	Chromium The open-source project behind Google Chrome.	`ghcr.io/m1k1o/neko/chromium`
	Google Chrome The most popular browser in the world.	`ghcr.io/m1k1o/neko/google-chrome`
	Ungoogled Chromium A fork of Chromium without Google integration.	`ghcr.io/m1k1o/neko/ungoogled-chromium`
	Microsoft Edge The new Microsoft Edge is based on Chromium.	`ghcr.io/m1k1o/neko/microsoft-edge`
	Brave A privacy-focused browser.	`ghcr.io/m1k1o/neko/brave`
	Vivaldi A highly customizable browser.	`ghcr.io/m1k1o/neko/vivaldi`
	Opera* A fast and secure browser.	`ghcr.io/m1k1o/neko/opera`

* requires extra steps to enable DRM, see instructions here. libffmpeg is already configured.

Desktop Environments

These images feature a full desktop environment where you can install and run multiple applications, use window management, and more. This is useful for people who want to run multiple applications in a single container.

Icon	Name	Docker Image
	Xfce A lightweight desktop environment.	`ghcr.io/m1k1o/neko/xfce`
	KDE Plasma A feature-rich desktop environment.	`ghcr.io/m1k1o/neko/kde`

Other Applications

As it would be impossible to include all possible applications in the repository, a couple of the most popular ones that work well with Neko have been chosen. Custom images can be created by using the base image and installing the desired application.

Icon	Name	Docker Image
	Remmina A remote desktop client.	`ghcr.io/m1k1o/neko/remmina`
	VLC A media player.	`ghcr.io/m1k1o/neko/vlc`

Remmina Configuration

To use Remmina with Neko, you can either pass the REMMINA_URL=<proto>://[<username>[:<password>]@]server[:port] environment variable (proto being vnc, rdp or spice):

docker run \
  -e REMMINA_URL=vnc://server:5900 \
  ghcr.io/m1k1o/neko/remmina

Or bind-mount a custom configuration file to ~/.local/share/remmina/path_to_profile.remmina. Then pass the REMMINA_PROFILE=<path_to_profile.remmina> environment variable:

[remmina]
name=Default
protocol=VNC
server=server.local
port=5900

docker run \
  -v /path/to/default.remmina:/root/.local/share/remmina/default.remmina \
  -e REMMINA_PROFILE=/root/.local/share/remmina/default.remmina \
  ghcr.io/m1k1o/neko/remmina

VLC Configuration

To use VLC with Neko, you can either pass the VLC_MEDIA=<url> environment variable:

docker run \
  -e VLC_MEDIA=http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4 \
  ghcr.io/m1k1o/neko/vlc

You can also bind-mount your local media files to the container, create a custom playlist, and pass the VLC_MEDIA=<path_to_playlist> environment variable:

docker run \
  -v /path/to/media:/media \
  -e VLC_MEDIA=/media/playlist.xspf \
  ghcr.io/m1k1o/neko/vlc

:::tip See neko-apps repository for more applications. :::

Available Flavors

:::danger Keep in Mind Currently the focus is on AMD64 & CPU image (wihout any flavor). So the flavor images might not work as expected. :::

The following flavors are available for Neko Docker images:

arm - ARM64 and ARMv7 architecture support.
nvidia - NVIDIA GPU support.
intel - Intel GPU support.

:::note Not all flavors are available for all applications. Since not all applications support ARM architecture or GPU acceleration, the flavors are only available where they make sense. :::

ARM

For ARM-based images (like Raspberry Pi - with GPU hardware acceleration, Oracle Cloud ARM free tier). Currently, not all images are available for ARM, because not all applications are available for ARM. Please use the images below:

The base image is available at ghcr.io/m1k1o/neko/arm-base.

Intel

For images with VAAPI GPU hardware acceleration using Intel drivers use:

The base image is available at ghcr.io/m1k1o/neko/intel-base.

Nvidia

For images with Nvidia GPU hardware acceleration using EGL use:

The base image is available at ghcr.io/m1k1o/neko/nvidia-base.

:::danger There is a known issue with EGL and Chromium-based browsers, see m1k1o/neko #279. :::

11 KiB Raw Blame History