Skip to main content
Version: v2

Frequently Asked Questions

How to enable debug mode?​

To see verbose information from n.eko server, you can enable debug mode using NEKO_DEBUG.

docker-compose.yaml
version: "3.4"
services:
  neko:
    image: "m1k1o/neko:firefox"
    restart: "unless-stopped"
    shm_size: "2gb"
    ports:
    - "8080:8080"
    - "52000-52100:52000-52100/udp"
    environment:
      NEKO_SCREEN: 1920x1080@30
      NEKO_PASSWORD: neko
      NEKO_PASSWORD_ADMIN: admin
      NEKO_EPR: 52000-52100
      NEKO_DEBUG: 1

Ensure, that you have enabled debug mode in javascript console too, in order to see verbose information from client.

Chinese input method is not working​

There exists an extension Google Input Tools for Chrome that allows you to use Chinese input method.

Only black screen is displayed but remote cursor is moving for Chromium-based browsers (Chrome, Edge, etc.)​

Check if you did not forget to add cap_add to your docker-compose file.

docker-compose.yaml
version: "3.4"
services:
  neko:
    image: "m1k1o/neko:chromium"
    cap_add:
    - SYS_ADMIN
    restart: "unless-stopped"
    shm_size: "2gb"
    ports:
    - "8080:8080"
    - "52000-52100:52000-52100/udp"
    environment:
      NEKO_SCREEN: '1920x1080@30'
      NEKO_PASSWORD: neko
      NEKO_PASSWORD_ADMIN: admin
      NEKO_EPR: 52000-52100

How can I embed the Neko desktop into web page without login prompt coming up for viewers?​

You can use the following URL to embed the Neko desktop into a web page without login prompt coming up for viewers:

http://<your-neko-server-ip>:8080/?usr=neko&pwd=neko

https://stackoverflow.com/questions/15276929/how-to-make-a-video-fullscreen-when-it-is-placed-inside-an-iframe

Your iframe needs an attribute: allowfullscreen="true" webkitallowfullscreen="true" mozallowfullscreen="true" or more modern allow="fullscreen *". For the second you can remove the star if your iframe has the same origin or replace it with your iframe origin.

Can I use neko without docker?​

It is strongly recommended to use Neko with Docker, as it is the easiest way to run it. But you should be able to install Neko "natively" on your host system. Neko is based on Debian and uses Xorg and Pulseaudio. You would just need to follow steps that are in Dockerfile, install all dependencies on your host system and then just run it.

However, it is recommend to start with existing system that has GUI with desktop manager, is based on Xorg and uses Pulseaudio (e.g. Ubuntu Desktop 22.04). For that matter you only need to install gstreamer dependencies, configure pulseaudio properly and run neko binary (you don't need to build it from scratch, you can copy it from docker image).