Skip to content

Commit e507c17

Browse files
jlesagejlesage
committed
Updated documentation.
1 parent 9427441 commit e507c17

1 file changed

Lines changed: 30 additions & 30 deletions

File tree

‎README.md‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ Foundation and its subsidiary, Mozilla Corporation.
4444
* [SSVNC](#ssvnc)
4545
* [Certificates](#certificates)
4646
* [VNC Password](#vnc-password)
47-
* [Web Control Panel](#web-control-panel)
4847
* [Web Authentication](#web-authentication)
4948
* [Configuring Users Credentials](#configuring-users-credentials)
5049
* [Reverse Proxy](#reverse-proxy)
5150
* [Routing Based on Hostname](#routing-based-on-hostname)
5251
* [Routing Based on URL Path](#routing-based-on-url-path)
52+
* [Web Control Panel](#web-control-panel)
5353
* [Automatic Clipboard Sync](#automatic-clipboard-sync)
5454
* [Web Audio](#web-audio)
5555
* [Web File Manager](#web-file-manager)
@@ -470,34 +470,6 @@ Unauthorized users with sufficient host privileges can retrieve the password by:
470470
> Framebuffer Protocol [RFC](https://tools.ietf.org/html/rfc6143) (see section
471471
> [7.2.2](https://tools.ietf.org/html/rfc6143#section-7.2.2)).
472472
473-
### Web Control Panel
474-
475-
The control panel is available whenever the application GUI is accessed through
476-
a web browser. Click the small three-dots tab on the left edge of the browser
477-
window to open it.
478-
479-
![Web Control Panel](https://images.weserv.nl/?url=raw.githubusercontent.com/jlesage/docker-templates/master/jlesage/images/control-panel.png&w=500)
480-
481-
| Control | Action / Purpose |
482-
|---------|------------------|
483-
| **X** icon | Closes the control panel. |
484-
| **Logout** icon | Logs out from the web interface. Visible only when [web authentication](#web-authentication) is enabled. |
485-
| **Keyboard** icon | Toggle the on-screen keyboard. Visible only on touch devices. |
486-
| **Fullscreen** icon | Toggle fullscreen mode for the browser window. |
487-
| **Hand** icon| Allows dragging/moving the application window. Visible only when **Scaling Mode** is *None* and **Clip to Window** is enabled.
488-
| **Folder** icon | Opens the intgegrated file browser. Visible only when the [file manager](#web-file-manager) is enabled. |
489-
| **Clipboard** text box| Mirrors the application’s clipboard. Any text typed or pasted here is sent to the application, and text copied inside the application automatically appears here. Hidden when [automatic clipboard synchronization](#automatic-clipboard-sync) is active. |
490-
| **Clear** button | Clears the clipboard. Hidden when [automatic clipboard synchronization](#automatic-clipboard-sync) is active. |
491-
| **Audio** icon | Mutes or unmutes audio streaming from the container. Visible only when [audio support](#web-audio) is enabled. |
492-
| **Volume** slider| Controls the playback volume of the audio streaming from the container. Visible only when [audio support](#web-audio) is enabled. |
493-
| **Clip to Window** toggle | Only applies when **Scaling Mode** is *None*. When disabled, scrollbars appear if the application window is larger than the browser window. When enabled, no scrollbars are shown and the hand icon is used to pan. |
494-
| **Scaling Mode** dropdown | Controls how the application window is scaled to fit the browser. **None** – no scaling, the application window keeps its original size. **Local Scaling** – the image is scaled in the browser (application window size unchanged). **Remote Scaling** – the application window inside the container is automatically resized to match the browser window size. |
495-
| **Quality** slider | Adjusts image quality. Moving the slider left reduces bandwidth at the cost of visual quality. |
496-
| **Compression** slider | Adjusts compression level applied to screen updates. Moving the slider right increases compression, which lowers bandwidth but raises CPU usage. |
497-
| **Logging** dropdown | Sets the verbosity level of the web interface logs shown in the browser console. |
498-
| **Application version** label | Displays the version of the application running inside the container. |
499-
| **Docker image** version label | Displays the version of the Docker image currently running. |
500-
501473
### Web Authentication
502474
503475
Access to the application's GUI via a web browser can be protected with a login
@@ -650,6 +622,34 @@ server {
650622
651623
```
652624
625+
## Web Control Panel
626+
627+
The control panel is available whenever the application GUI is accessed through
628+
a web browser. Click the small three-dots tab on the left edge of the browser
629+
window to open it.
630+
631+
![Web Control Panel](https://images.weserv.nl/?url=raw.githubusercontent.com/jlesage/docker-templates/master/jlesage/images/control-panel.png&w=500)
632+
633+
| Control | Action / Purpose |
634+
|---------|------------------|
635+
| **X** icon | Closes the control panel. |
636+
| **Logout** icon | Logs out from the web interface. Visible only when [web authentication](#web-authentication) is enabled. |
637+
| **Keyboard** icon | Toggle the on-screen keyboard. Visible only on touch devices. |
638+
| **Fullscreen** icon | Toggle fullscreen mode for the browser window. |
639+
| **Hand** icon| Allows dragging/moving the application window. Visible only when **Scaling Mode** is *None* and **Clip to Window** is enabled.
640+
| **Folder** icon | Opens the intgegrated file browser. Visible only when the [file manager](#web-file-manager) is enabled. |
641+
| **Clipboard** text box| Mirrors the application’s clipboard. Any text typed or pasted here is sent to the application, and text copied inside the application automatically appears here. Hidden when [automatic clipboard synchronization](#automatic-clipboard-sync) is active. |
642+
| **Clear** button | Clears the clipboard. Hidden when [automatic clipboard synchronization](#automatic-clipboard-sync) is active. |
643+
| **Audio** icon | Mutes or unmutes audio streaming from the container. Visible only when [audio support](#web-audio) is enabled. |
644+
| **Volume** slider| Controls the playback volume of the audio streaming from the container. Visible only when [audio support](#web-audio) is enabled. |
645+
| **Clip to Window** toggle | Only applies when **Scaling Mode** is *None*. When disabled, scrollbars appear if the application window is larger than the browser window. When enabled, no scrollbars are shown and the hand icon is used to pan. |
646+
| **Scaling Mode** dropdown | Controls how the application window is scaled to fit the browser. **None** – no scaling, the application window keeps its original size. **Local Scaling** – the image is scaled in the browser (application window size unchanged). **Remote Scaling** – the application window inside the container is automatically resized to match the browser window size. |
647+
| **Quality** slider | Adjusts image quality. Moving the slider left reduces bandwidth at the cost of visual quality. |
648+
| **Compression** slider | Adjusts compression level applied to screen updates. Moving the slider right increases compression, which lowers bandwidth but raises CPU usage. |
649+
| **Logging** dropdown | Sets the verbosity level of the web interface logs shown in the browser console. |
650+
| **Application version** label | Displays the version of Firefox integrated into Docker image. |
651+
| **Docker image** version label | Displays the version of the Docker image currently running. |
652+
653653
## Automatic Clipboard Sync
654654
655655
When the container is accessed through a web browser, automatic clipboard
@@ -693,7 +693,7 @@ Enable web audio by setting `WEB_AUDIO` to `1`. See the
693693
[Environment Variables](#environment-variables) section for details on
694694
configuring environment variables.
695695
696-
Control of the audio (mute, unmute and volume) is done via the
696+
Control of the audio stream (mute, unmute and volume) is done via the
697697
[control panel](#web-control-panel).
698698
699699
## Web File Manager

0 commit comments

Comments
 (0)