diff --git a/webpage/docs/developer-guide/building-from-source.md b/webpage/docs/developer-guide/building-from-source.md index 9259f8d2..f6473e66 100644 --- a/webpage/docs/developer-guide/building-from-source.md +++ b/webpage/docs/developer-guide/building-from-source.md @@ -4,4 +4,66 @@ sidebar_position: 2 # Building from Source -How to compile and run Neko from the source code. +This guide walks you through the process of setting up Neko on your local machine or server. + +## Prerequisites + +Before proceeding, ensure that you have the following installed on your system: + +- [node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) (for building the frontend). +- [go](https://golang.org/) (for building the server). +- [gstreamer](https://gstreamer.freedesktop.org/) (for video processing). + ```shell + sudo apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \ + gstreamer1.0-plugins-base gstreamer1.0-plugins-good \ + gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \ + gstreamer1.0-pulseaudio; + ``` +- [x.org](https://www.x.org/) (for X11 server). + ```shell + sudo apt-get install libx11-dev libxrandr-dev libxtst-dev libxcvt-dev xorg; + ``` +- [pulseaudio](https://www.freedesktop.org/wiki/Software/PulseAudio/) (for audio support). + ```shell + sudo apt-get install pulseaudio; + ``` +- other dependencies: + ```shell + sudo apt-get install xdotool xclip libgtk-3-0 libgtk-3-dev libopus0 libvpx6; + ``` + +## Step 1: Clone the Repository + +Start by cloning the Neko Git repository to your machine: + +```bash +git clone https://github.com/m1k1o/neko.git +cd neko +``` + +## Step 2: Build the Frontend + +Navigate to the `client` directory and install the dependencies: + +```shell +cd client; +npm install; +npm run build; +``` + +## Step 3: Build the Server + +Navigate to the `server` directory and build the server: + +```shell +cd server; +go build; +``` + +## Step 4: Run the Server + +Finally, run the server: + +```shell +./server/server; +``` diff --git a/webpage/docs/getting-started/docker-images.md b/webpage/docs/getting-started/docker-images.md new file mode 100644 index 00000000..ca60ece3 --- /dev/null +++ b/webpage/docs/getting-started/docker-images.md @@ -0,0 +1,217 @@ +--- +sidebar_position: 4 +--- + +# Available 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`](https://ghcr.io/m1k1o/neko/base). + +## Naming Convention + +Neko Docker images are available on [GitHub Container Registry (GHCR)](https://github.com/m1k1o?tab=packages&repo_name=neko). The naming convention for Neko Docker images is as follows: + +``` +ghcr.io/m1k1o/neko/[-]: +``` + +- `` is the optional flavor of the image, see [Available Flavors](#available-flavors) for more information. +- `` is the application name or base image, see [Available Applications](#available-applications) for more information. +- `` is the [semantic version](https://semver.org/) of the image from the [GitHub tags](https://github.com/m1k1o/neko/tags). There is always a `latest` tag available. + +An alternative registry is also available on [Docker Hub](https://hub.docker.com/r/m1k1o/neko), however, only images without flavor and with the latest version are available there. + +``` +m1k1o/neko: +``` + +:::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](https://www.mozilla.org/firefox/)
The open-source browser from Mozilla. | [`ghcr.io/m1k1o/neko/firefox`](https://ghcr.io/m1k1o/neko/firefox) | +| | [Tor Browser](https://www.torproject.org/)
The privacy-focused browser from the Tor Project. | [`ghcr.io/m1k1o/neko/tor-browser`](https://ghcr.io/m1k1o/neko/tor-browser) | + +### 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](https://www.redhat.com/en/blog/container-tidbits-adding-capabilities-container) 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.yml" + cap_add: + - SYS_ADMIN + shm_size: 2g + ``` + + + + +| Icon | Name | Docker Image | +| ---- | ---- | ------------ | +| | [Chromium](https://www.chromium.org/chromium-projects/)
The open-source project behind Google Chrome. | [`ghcr.io/m1k1o/neko/chromium`](https://ghcr.io/m1k1o/neko/chromium) | +| | [Google Chrome](https://www.google.com/chrome/)
The most popular browser in the world. | [`ghcr.io/m1k1o/neko/google-chrome`](https://ghcr.io/m1k1o/neko/google-chrome) | +| | [Ungoogled Chromium](https://github.com/Eloston/ungoogled-chromium)
A fork of Chromium without Google integration. | [`ghcr.io/m1k1o/neko/ungoogled-chromium`](https://ghcr.io/m1k1o/neko/ungoogled-chromium) | +| | [Microsoft Edge](https://www.microsoft.com/edge)
The new Microsoft Edge is based on Chromium. | [`ghcr.io/m1k1o/neko/microsoft-edge`](https://ghcr.io/m1k1o/neko/microsoft-edge) | +| | [Brave](https://brave.com/)
A privacy-focused browser. | [`ghcr.io/m1k1o/neko/brave`](https://ghcr.io/m1k1o/neko/brave) | +| | [Vivaldi](https://vivaldi.com/)
A highly customizable browser. | [`ghcr.io/m1k1o/neko/vivaldi`](https://ghcr.io/m1k1o/neko/vivaldi) | +| | [Opera](https://www.opera.com/)*
A fast and secure browser. | [`ghcr.io/m1k1o/neko/opera`](https://ghcr.io/m1k1o/neko/opera) | + +\* requires extra steps to enable DRM, see instructions [here](https://www.reddit.com/r/operabrowser/wiki/opera/linux_widevine_config/). `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](https://xfce.org/)
A lightweight desktop environment. | [`ghcr.io/m1k1o/neko/xfce`](https://ghcr.io/m1k1o/neko/xfce) | +| | [KDE Plasma](https://kde.org/plasma-desktop)
A feature-rich desktop environment. | [`ghcr.io/m1k1o/neko/kde`](https://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](https://remmina.org/)
A remote desktop client. | [`ghcr.io/m1k1o/neko/remmina`](https://ghcr.io/m1k1o/neko/remmina) | +| | [VLC](https://www.videolan.org/vlc/)
A media player. | [`ghcr.io/m1k1o/neko/vlc`](https://ghcr.io/m1k1o/neko/vlc) | + +#### Remmina Configuration + +To use Remmina with Neko, you can either pass the `REMMINA_URL=://[[:]@]server[:port]` environment variable (proto being `vnc`, `rdp` or `spice`): + +```bash +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=` environment variable: + +```ini title="default.remmina" +[remmina] +name=Default +protocol=VNC +server=server.local +port=5900 +``` + +```bash +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=` environment variable: + +```bash +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=` environment variable: + +```bash +docker run \ + -v /path/to/media:/media \ + -e VLC_MEDIA=/media/playlist.xspf \ + ghcr.io/m1k1o/neko/vlc +``` + +:::tip +See [neko-apps](https://github.com/m1k1o/neko-apps) repository for more applications. +::: + +## Available Flavors + +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](https://www.oracle.com/cloud/free/)). Currently, not all images are available for ARM, because not all applications are available for ARM. Please use the images below: + +- [`ghcr.io/m1k1o/neko/arm-firefox`](https://ghcr.io/m1k1o/neko/arm-firefox) +- [`ghcr.io/m1k1o/neko/arm-chromium`](https://ghcr.io/m1k1o/neko/arm-chromium) +- [`ghcr.io/m1k1o/neko/arm-ungoogled-chromium`](https://ghcr.io/m1k1o/neko/arm-ungoogled-chromium) +- [`ghcr.io/m1k1o/neko/arm-vlc`](https://ghcr.io/m1k1o/neko/arm-vlc) +- [`ghcr.io/m1k1o/neko/arm-xfce`](https://ghcr.io/m1k1o/neko/arm-xfce) + +The base image is available at [`ghcr.io/m1k1o/neko/arm-base`](https://ghcr.io/m1k1o/neko/arm-base). + +### Intel + +For images with VAAPI GPU hardware acceleration using Intel drivers use: + +- [`ghcr.io/m1k1o/neko/intel-firefox`](https://ghcr.io/m1k1o/neko/intel-firefox) +- [`ghcr.io/m1k1o/neko/intel-chromium`](https://ghcr.io/m1k1o/neko/intel-chromium) +- [`ghcr.io/m1k1o/neko/intel-google-chrome`](https://ghcr.io/m1k1o/neko/intel-google-chrome) +- [`ghcr.io/m1k1o/neko/intel-ungoogled-chromium`](https://ghcr.io/m1k1o/neko/intel-ungoogled-chromium) +- [`ghcr.io/m1k1o/neko/intel-microsoft-edge`](https://ghcr.io/m1k1o/neko/intel-microsoft-edge) +- [`ghcr.io/m1k1o/neko/intel-brave`](https://ghcr.io/m1k1o/neko/intel-brave) +- [`ghcr.io/m1k1o/neko/intel-vivaldi`](https://ghcr.io/m1k1o/neko/intel-vivaldi) +- [`ghcr.io/m1k1o/neko/intel-opera`](https://ghcr.io/m1k1o/neko/intel-opera) +- [`ghcr.io/m1k1o/neko/intel-tor-browser`](https://ghcr.io/m1k1o/neko/intel-tor-browser) +- [`ghcr.io/m1k1o/neko/intel-remmina`](https://ghcr.io/m1k1o/neko/intel-remmina) +- [`ghcr.io/m1k1o/neko/intel-vlc`](https://ghcr.io/m1k1o/neko/intel-vlc) +- [`ghcr.io/m1k1o/neko/intel-xfce`](https://ghcr.io/m1k1o/neko/intel-xfce) +- [`ghcr.io/m1k1o/neko/intel-kde`](https://ghcr.io/m1k1o/neko/intel-kde) + +The base image is available at [`ghcr.io/m1k1o/neko/intel-base`](https://ghcr.io/m1k1o/neko/intel-base). + +### Nvidia + +For images with Nvidia GPU hardware acceleration using EGL use: + +- [`ghcr.io/m1k1o/neko/nvidia-firefox`](https://ghcr.io/m1k1o/neko/nvidia-firefox) +- [`ghcr.io/m1k1o/neko/nvidia-chromium`](https://ghcr.io/m1k1o/neko/nvidia-chromium) +- [`ghcr.io/m1k1o/neko/nvidia-google-chrome`](https://ghcr.io/m1k1o/neko/nvidia-google-chrome) +- [`ghcr.io/m1k1o/neko/nvidia-microsoft-edge`](https://ghcr.io/m1k1o/neko/nvidia-microsoft-edge) +- [`ghcr.io/m1k1o/neko/nvidia-brave`](https://ghcr.io/m1k1o/neko/nvidia-brave) + +The base image is available at [`ghcr.io/m1k1o/neko/nvidia-base`](https://ghcr.io/m1k1o/neko/nvidia-base). + +:::danger +There is a known issue with EGL and Chromium-based browsers, see [m1k1o/neko #279](https://github.com/m1k1o/neko/issues/279). +::: + diff --git a/webpage/docs/getting-started/docker-run.md b/webpage/docs/getting-started/docker-run.md new file mode 100644 index 00000000..f4a11149 --- /dev/null +++ b/webpage/docs/getting-started/docker-run.md @@ -0,0 +1,85 @@ +--- +sidebar_position: 3 +--- + +# Running Neko in Docker + +To start a basic Neko container, use the following command: + +```sh +docker run -d --rm \ + -p 8080:8080 \ + -p 56000-56100:56000-56100/udp \ + -e NEKO_WEBRTC_EPR=56000-56100 \ + -e NEKO_WEBRTC_NAT1TO1=127.0.0.1 \ + -e NEKO_MEMBER_MULTIUSER_USER_PASSWORD=neko \ + -e NEKO_MEMBER_MULTIUSER_ADMIN_PASSWORD=admin \ + ghcr.io/m1k1o/neko/firefox:latest +``` + +### Explanation + +- `-d` - Run the container in the background. +- `--rm` - Automatically remove the container when it exits. +- `-p 8080:8080` - Map the container's port `8080` to the host's port `8080`. +- `-p 56000-56100:56000-56100/udp` - Map the container's UDP ports `56000-56100` to the host's ports `56000-56100`. +- `-e NEKO_WEBRTC_EPR=56000-56100` - Set the WebRTC endpoint range, must match the mapped ports. + - See [WebRTC Ephemeral Port Range](/docs/v3/getting-started/configuration/webrtc#ephemeral-udp-port-range) for more information about this setting. +- `-e NEKO_WEBRTC_NAT1TO1=127.0.0.1` - Set the NAT1TO1 IP address. + - To test only on the local computer, use `127.0.0.1`. + - To use it in a private network, use the host's IP address (e.g., `192.168.1.5`). + - To use it in a public network, you need to correctly set up port forwarding on your router and remove this env variable. + - See [WebRTC Server IP Address](/docs/v3/getting-started/configuration/webrtc#server-ip-address) for more information about this setting. +- `-e NEKO_MEMBER_MULTIUSER_USER_PASSWORD=neko` - Set the password for the user account. +- `-e NEKO_MEMBER_MULTIUSER_ADMIN_PASSWORD=admin` - Set the password for the admin account. + - See [Multiuser Configuration](/docs/v3/getting-started/configuration/authentication#multi-user-provider) for more information about this setting. +- `ghcr.io/m1k1o/neko/firefox:latest` - The Neko Docker image to use. + - See [Available Docker Images](/docs/v3/getting-started/docker-images) for more information about the available images. + +Now, open your browser and go to: `http://localhost:8080`. You should see the Neko interface. + +## Using Docker Compose + +You can also use Docker Compose to run Neko. It is preferred to use Docker Compose for running Neko in production because you can easily manage the container, update it, and configure it. + +Create a `docker-compose.yml` file with the following content: + +```yaml title="docker-compose.yml" +services: + neko: + image: ghcr.io/m1k1o/neko/firefox:latest + restart: unless-stopped + ports: + - "8080:8080" + - "56000-56100:56000-56100/udp" + environment: + NEKO_WEBRTC_EPR: "56000-56100" + NEKO_WEBRTC_NAT1TO1: "127.0.0.1" + NEKO_MEMBER_MULTIUSER_USER_PASSWORD: "neko" + NEKO_MEMBER_MULTIUSER_ADMIN_PASSWORD: "admin" +``` + +Then, run the following command: + +```sh +docker compose up -d +``` + +To stop Neko, run: + +```sh +docker compose down +``` + +To update Neko, run: + +```sh +docker compose pull +docker compose up -d +``` + +Learn more about [how compose works](https://docs.docker.com/compose/intro/compose-application-model/). + +:::note +You need to be in the same directory as the `docker-compose.yml` file to run the `docker compose` commands. +::: diff --git a/webpage/docs/getting-started/installation/_category_.json b/webpage/docs/getting-started/installation/_category_.json deleted file mode 100644 index 46926fe4..00000000 --- a/webpage/docs/getting-started/installation/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "position": 3, - "label": "Installation", - "link": { - "type": "generated-index", - "description": "There are multiple ways to install neko, choose the one that fits your needs." - } -} diff --git a/webpage/docs/getting-started/installation/cloud-deployment.md b/webpage/docs/getting-started/installation/cloud-deployment.md deleted file mode 100644 index 2d85e6dc..00000000 --- a/webpage/docs/getting-started/installation/cloud-deployment.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Cloud Deployments - -:::warning -This page is a work in progress. [Docker Setup](./docker-setup.md) is the recommended way to install Neko. -::: - -Neko can be deployed to various cloud platforms for scalable, high-availability solutions. This guide walks you through deploying Neko on popular cloud providers such as AWS, Google Cloud, and Azure. diff --git a/webpage/docs/getting-started/installation/docker-setup.md b/webpage/docs/getting-started/installation/docker-setup.md deleted file mode 100644 index a1320945..00000000 --- a/webpage/docs/getting-started/installation/docker-setup.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Docker Setup - -
- - - - - - - - - - - - -
- -Use the following docker images from [Docker Hub](https://hub.docker.com/r/m1k1o/neko) for x86_64: -- `m1k1o/neko:latest` or `m1k1o/neko:firefox` - for Firefox. -- `m1k1o/neko:chromium` - for Chromium (needs `--cap-add=SYS_ADMIN`, see the [security implications](https://www.redhat.com/en/blog/container-tidbits-adding-capabilities-container)). -- `m1k1o/neko:google-chrome` - for Google Chrome (needs `--cap-add=SYS_ADMIN`, see the [security implications](https://www.redhat.com/en/blog/container-tidbits-adding-capabilities-container)). -- `m1k1o/neko:ungoogled-chromium` - for [Ungoogled Chromium](https://github.com/Eloston/ungoogled-chromium) (needs `--cap-add=SYS_ADMIN`, see the [security implications](https://www.redhat.com/en/blog/container-tidbits-adding-capabilities-container)) (by @whalehub). -- `m1k1o/neko:microsoft-edge` - for Microsoft Edge (needs `--cap-add=SYS_ADMIN`, see the [security implications](https://www.redhat.com/en/blog/container-tidbits-adding-capabilities-container)). -- `m1k1o/neko:brave` - for [Brave Browser](https://brave.com) (needs `--cap-add=SYS_ADMIN`, see the [security implications](https://www.redhat.com/en/blog/container-tidbits-adding-capabilities-container)). -- `m1k1o/neko:vivaldi` - for [Vivaldi Browser](https://vivaldi.com) (needs `--cap-add=SYS_ADMIN`, see the [security implications](https://www.redhat.com/en/blog/container-tidbits-adding-capabilities-container)) (by @Xeddius). -- `m1k1o/neko:opera` for [Opera Browser](https://opera.com) (requires extra steps to enable DRM, see instructions [here](https://www.reddit.com/r/operabrowser/wiki/opera/linux_widevine_config/). libffmpeg is already configured.) (by @prophetofxenu) -- `m1k1o/neko:tor-browser` - for Tor Browser. -- `m1k1o/neko:remmina` - for remote desktop connection (by @lowne). - - Pass env var `REMMINA_URL=://[[:]@]server[:port]` (proto being `vnc`, `rdp` or `spice`). - - Or create your custom configuration with remmina locally (it's saved in `~/.local/share/remmina/path_to_profile.remmina`) and bind-mount it, then pass env var `REMMINA_PROFILE=`. -- `m1k1o/neko:vlc` - for VLC Video player (needs volume mounted to `/media` with local video files, or setting `VLC_MEDIA=/media` path). -- `m1k1o/neko:xfce` or `m1k1o/neko:kde` - for a shared desktop / installing shared software. -- `m1k1o/neko:base` - for custom base. - -Dockerhub images are built using GitHub actions on every push and on weekly basis to keep all browsers up-to-date. - -All images are also available on [GitHub Container Registry](https://github.com/m1k1o?tab=packages&repo_name=neko) for faster pulls: - -- `ghcr.io/m1k1o/neko/firefox:latest` -- `ghcr.io/m1k1o/neko/chromium:latest` -- `ghcr.io/m1k1o/neko/google-chrome:latest` -- `ghcr.io/m1k1o/neko/ungoogled-chromium:latest` -- `ghcr.io/m1k1o/neko/microsoft-edge:latest` -- `ghcr.io/m1k1o/neko/brave:latest` -- `ghcr.io/m1k1o/neko/vivaldi:latest` -- `ghcr.io/m1k1o/neko/opera:latest` -- `ghcr.io/m1k1o/neko/tor-browser:latest` -- `ghcr.io/m1k1o/neko/remmina:latest` -- `ghcr.io/m1k1o/neko/vlc:latest` -- `ghcr.io/m1k1o/neko/xfce:latest` -- `ghcr.io/m1k1o/neko/kde:latest` - -For ARM-based images (like Raspberry Pi - with GPU hardware acceleration, Oracle Cloud ARM tier). Currently, not all images are available for ARM, because not all applications are available for ARM. Please note, that `m1k1o/neko:arm-*` images from dockerhub are currently not maintained and they can contain outdated software. Please use images below: - -- `ghcr.io/m1k1o/neko/arm-firefox:latest` -- `ghcr.io/m1k1o/neko/arm-chromium:latest` -- `ghcr.io/m1k1o/neko/arm-ungoogled-chromium:latest` -- `ghcr.io/m1k1o/neko/arm-vlc:latest` -- `ghcr.io/m1k1o/neko/arm-xfce:latest` - -For images with VAAPI GPU hardware acceleration using intel drivers use: - -- `ghcr.io/m1k1o/neko/intel-firefox:latest` -- `ghcr.io/m1k1o/neko/intel-chromium:latest` -- `ghcr.io/m1k1o/neko/intel-google-chrome:latest` -- `ghcr.io/m1k1o/neko/intel-ungoogled-chromium:latest` -- `ghcr.io/m1k1o/neko/intel-microsoft-edge:latest` -- `ghcr.io/m1k1o/neko/intel-brave:latest` -- `ghcr.io/m1k1o/neko/intel-vivaldi:latest` -- `ghcr.io/m1k1o/neko/intel-opera:latest` -- `ghcr.io/m1k1o/neko/intel-tor-browser:latest` -- `ghcr.io/m1k1o/neko/intel-remmina:latest` -- `ghcr.io/m1k1o/neko/intel-vlc:latest` -- `ghcr.io/m1k1o/neko/intel-xfce:latest` -- `ghcr.io/m1k1o/neko/intel-kde:latest` - -For images with Nvidia GPU hardware acceleration using EGL (see example below) use (please note, there is a known issue with EGL and Chromium-based browsers, see [here](https://github.com/m1k1o/neko/issues/279)): - -- `ghcr.io/m1k1o/neko/nvidia-firefox:latest` -- `ghcr.io/m1k1o/neko/nvidia-chromium:latest` -- `ghcr.io/m1k1o/neko/nvidia-google-chrome:latest` -- `ghcr.io/m1k1o/neko/nvidia-microsoft-edge:latest` -- `ghcr.io/m1k1o/neko/nvidia-brave:latest` - -GHCR images are built using GitHub actions for every tag. - -## Running Neko with Docker - -To start a basic Neko container, use the following command: - -```sh -docker run -d --rm \ - -p 8080:8080 \ - -p 56000-56100:56000-56100/udp \ - -e NEKO_EPR=56000-56100 \ - -e NEKO_PASSWORD=neko \ - -e NEKO_PASSWORD_ADMIN=admin \ - -e NEKO_NAT1TO1= \ - --shm-size=2g \ - m1k1o/neko:latest -``` - -### Explanation - -- `-d` - Run the container in the background. -- `--rm` - Automatically remove the container when it exits. -- `-p 8080:8080` - Map the host's port `8080` to the container's port `8080`. -- `-p 56000-56100:56000-56100/udp` - Map the host's ports `56000-56100` to the container's ports `56000-56100` using UDP. -- `-e NEKO_EPR=56000-56100` - Set the range of ports for the WebRTC connection, it must match the port range mapped above. -- `-e NEKO_PASSWORD=neko` and `-e NEKO_PASSWORD_ADMIN=admin` - Set passwords for the user and admin user. -- `-e NEKO_NAT1TO1=` - Set the public or local IP address for the NAT1:1 connection. -- `--shm-size=2g` - Set the shared memory size to 2GB, otherwise, the browser may crash. -- `m1k1o/neko:latest` - The name of the image to run, change it to the desired image. - -Now, open your browser and go to: `http://localhost:8080`. You should see the Neko interface. - -## Using Docker Compose - -You can also use Docker Compose to run Neko. Create a `docker-compose.yml` file with the following content: - -```yaml title="docker-compose.yml" -services: - neko: - image: m1k1o/neko:latest - shm_size: 2g - ports: - - "8080:8080" - - "56000-56100:56000-56100/udp" - environment: - NEKO_EPR: 56000-56100 - NEKO_PASSWORD: neko - NEKO_PASSWORD_ADMIN: admin - NEKO_NAT1TO1: -``` - -Then, run the following command: - -```sh -docker compose up -d -``` diff --git a/webpage/docs/getting-started/installation/manual-installation.md b/webpage/docs/getting-started/installation/manual-installation.md deleted file mode 100644 index 47b1f19f..00000000 --- a/webpage/docs/getting-started/installation/manual-installation.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Manual Installation - -:::warning -This page is a work in progress. [Docker Setup](./docker-setup.md) is the recommended way to install Neko. -::: - -In some cases, you may want to install Neko manually without Docker. This guide walks you through the process of setting up Neko on your local machine or server. - -## Prerequisites - -Before proceeding, ensure that you have the following installed on your system: - -- [node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) (for building the frontend). -- [go](https://golang.org/) (for building the server). -- [gstreamer](https://gstreamer.freedesktop.org/) (for video processing). - ```shell - sudo apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \ - gstreamer1.0-plugins-base gstreamer1.0-plugins-good \ - gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \ - gstreamer1.0-pulseaudio; - ``` -- [x.org](https://www.x.org/) (for X11 server). - ```shell - sudo apt-get install libx11-dev libxrandr-dev libxtst-dev libxcvt-dev xorg; - ``` -- [pulseaudio](https://www.freedesktop.org/wiki/Software/PulseAudio/) (for audio support). - ```shell - sudo apt-get install pulseaudio; - ``` -- other dependencies: - ```shell - sudo apt-get install xdotool xclip libgtk-3-0 libgtk-3-dev libopus0 libvpx6; - ``` - -## Step 1: Clone the Repository - -Start by cloning the Neko Git repository to your machine: - -```bash -git clone https://github.com/m1k1o/neko.git -cd neko -``` - -## Step 2: Build the Frontend - -Navigate to the `client` directory and install the dependencies: - -```shell -cd client; -npm install; -npm run build; -``` - -## Step 3: Build the Server - -Navigate to the `server` directory and build the server: - -```shell -cd server; -go build; -``` - -## Step 4: Run the Server - -Finally, run the server: - -```shell -./server/server; -``` - diff --git a/webpage/docs/getting-started/quick-start-guide.md b/webpage/docs/getting-started/quick-start-guide.md index 08013c11..4a9d2aac 100644 --- a/webpage/docs/getting-started/quick-start-guide.md +++ b/webpage/docs/getting-started/quick-start-guide.md @@ -6,7 +6,7 @@ sidebar_position: 2 Neko is easy to use and requires no technical expertise to get started. All you need to do is download the Docker image and you're ready to go: -1. Deploy a server or VPS with public IP address. +1. Deploy a server or VPS with a public IP address. **Recommended Specs:** @@ -23,7 +23,7 @@ Neko is easy to use and requires no technical expertise to get started. All you ::: :::note - Admin can change the resolution in the GUI. + The admin can change the resolution in the GUI. ::: 2. [Login via SSH](https://www.digitalocean.com/docs/droplets/how-to/connect-with-ssh/). @@ -39,7 +39,7 @@ Neko is easy to use and requires no technical expertise to get started. All you sudo apt-get install docker-compose-plugin ``` -5. Download docker compose file and start it: +5. Download the docker compose file and start it: ```shell wget https://raw.githubusercontent.com/m1k1o/neko/master/docker-compose.yaml sudo docker compose up -d @@ -49,13 +49,13 @@ Neko is easy to use and requires no technical expertise to get started. All you If you want to run Neko on your local network, you have to add `NEKO_NAT1TO1=` to the `docker-compose.yaml` file. ::: -6. Visit the IP address server in your browser and login, the default password is `neko`. +6. Visit the server's IP address in your browser and log in, the default password is `neko`. :::tip Run `nano docker-compose.yaml` to edit the settings, then press `ctrl+x` to exit and save the file. ::: -## Well known cloud providers +## Well-known cloud providers * [Hetzner Cloud](https://www.hetzner.com/cloud) * [Digital Ocean](https://www.digitalocean.com/) * [Contabo](https://contabo.com/) diff --git a/webpage/docs/getting-started/running-neko.md b/webpage/docs/getting-started/running-neko.md deleted file mode 100644 index 13ebed9e..00000000 --- a/webpage/docs/getting-started/running-neko.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Running Neko - -How to start and manage a Neko instance on different environments. diff --git a/webpage/static/img/icons/remmina.png b/webpage/static/img/icons/remmina.png deleted file mode 100644 index bf910688..00000000 Binary files a/webpage/static/img/icons/remmina.png and /dev/null differ diff --git a/webpage/static/img/icons/remmina.svg b/webpage/static/img/icons/remmina.svg new file mode 100644 index 00000000..a07b1b0a --- /dev/null +++ b/webpage/static/img/icons/remmina.svg @@ -0,0 +1,200 @@ + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +