From e754e6687847174067859de5e5149c9c6e594c9c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miroslav=20=C5=A0ediv=C3=BD?= Date: Thu, 28 Mar 2024 23:47:20 +0100 Subject: [PATCH] added Frequently Asked Questions to docs. --- docs/_sidebar.md | 1 + docs/getting-started/faq.md | 51 +++++++++++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+) create mode 100644 docs/getting-started/faq.md diff --git a/docs/_sidebar.md b/docs/_sidebar.md index d8c4d12f..0196852f 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -6,6 +6,7 @@ * [Reverse Proxy](/getting-started/reverse-proxy) * [Configuration](/getting-started/configuration) * [Troubleshooting](/getting-started/troubleshooting) + * [Frequently Asked Questions](/getting-started/faq) * [Mobile Support](/mobile-support) * [Contributing](/contributing) * [Non Goals](/non-goals) diff --git a/docs/getting-started/faq.md b/docs/getting-started/faq.md new file mode 100644 index 00000000..1e9106f9 --- /dev/null +++ b/docs/getting-started/faq.md @@ -0,0 +1,51 @@ +# Frequently Asked Questions + +## How to enable debug mode? + +To see verbose information from n.eko server, you can enable debug mode using `NEKO_DEBUG`. + +```diff +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_ICELITE: 1 ++ 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 for Chrome that allows you to use Chinese input method. You can install it from [here](https://chrome.google.com/webstore/detail/mclkkofklkfljcocdinagocijmpgbhab). Alternatively, you can use Google Input Tools from [here](https://www.google.com/inputtools/chrome/). + +## 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. + +```yaml + cap_add: + - SYS_ADMIN +``` + +# 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://: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.