Skip to content

Commit db29ab5

Browse files
committed
Updated documentation.
1 parent 6255647 commit db29ab5

2 files changed

Lines changed: 33 additions & 23 deletions

File tree

DOCKERHUB.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,16 @@
77
[![Source](https://img.shields.io/badge/Source-GitHub-blue?logo=github&style=for-the-badge)](https://github.com/jlesage/docker-firefox)
88
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg?style=for-the-badge)](https://paypal.me/JocelynLeSage)
99

10-
This is a Docker container for [Firefox](https://www.mozilla.org/firefox/).
10+
This project provides a lightweight and secure Docker container for
11+
[Firefox](https://www.mozilla.org/firefox/).
1112

12-
The graphical user interface (GUI) of the application can be accessed through a
13-
modern web browser, requiring no installation or configuration on the client
13+
Access the application's full graphical interface directly from any modern web
14+
browser - no downloads, installs, or setup required on the client side - or
15+
connect with any VNC client.
16+
17+
The web interface also offers audio playback, seamless clipboard sharing, an
18+
integrated file manager and terminal for accessing the container's files and
19+
shell, desktop notifications, and more.
1420

1521
> This Docker container is entirely unofficial and not made by the creators of
1622
> Firefox.

README.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,16 @@
66
[![Build Status](https://img.shields.io/github/actions/workflow/status/jlesage/docker-firefox/build-image.yml?logo=github&branch=master&style=for-the-badge)](https://github.com/jlesage/docker-firefox/actions/workflows/build-image.yml)
77
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg?style=for-the-badge)](https://paypal.me/JocelynLeSage)
88

9-
This project provides a Docker container for [Firefox](https://www.mozilla.org/firefox/).
9+
This project provides a lightweight and secure Docker container for
10+
[Firefox](https://www.mozilla.org/firefox/).
1011

11-
The graphical user interface (GUI) of the application can be accessed through a
12-
modern web browser, requiring no installation or configuration on the client
13-
side, or via any VNC client.
12+
Access the application's full graphical interface directly from any modern web
13+
browser - no downloads, installs, or setup required on the client side - or
14+
connect with any VNC client.
15+
16+
The web interface also offers audio playback, seamless clipboard sharing, an
17+
integrated file manager and terminal for accessing the container's files and
18+
shell, desktop notifications, and more.
1419

1520
> [!NOTE]
1621
> This Docker container is entirely unofficial and not made by the creators of
@@ -40,6 +45,7 @@ Foundation and its subsidiary, Mozilla Corporation.
4045
* [Synology](#synology)
4146
* [unRAID](#unraid)
4247
* [User/Group IDs](#usergroup-ids)
48+
* [Shell Access](#shell-access)
4349
* [Accessing the GUI](#accessing-the-gui)
4450
* [Security](#security)
4551
* [SSVNC](#ssvnc)
@@ -55,9 +61,8 @@ Foundation and its subsidiary, Mozilla Corporation.
5561
* [Web Audio](#web-audio)
5662
* [Web File Manager](#web-file-manager)
5763
* [Web Notifications](#web-notifications)
58-
* [Web Terminal](#web-terminal)
64+
* [Web Terminal](#web-terminal)
5965
* [GPU Acceleration Support](#gpu-acceleration-support)
60-
* [Shell Access](#shell-access)
6166
* [Allowing the membarrier System Call](#allowing-the-membarrier-system-call)
6267
* [Setting Firefox Preferences Via Environment Variables](#setting-firefox-preferences-via-environment-variables)
6368
* [Troubleshooting](#troubleshooting)
@@ -243,7 +248,6 @@ Adjust the configuration to suit your needs. Only mandatory settings are
243248
included in this example.
244249
245250
```yaml
246-
version: '3'
247251
services:
248252
firefox:
249253
image: jlesage/firefox
@@ -360,6 +364,17 @@ uid=1000(myuser) gid=1000(myuser) groups=1000(myuser),4(adm),24(cdrom),27(sudo),
360364
361365
Use the `uid` (user ID) and `gid` (group ID) values to configure the container.
362366
367+
## Shell Access
368+
369+
To access the shell of a running container, execute the following command:
370+
371+
```shell
372+
docker exec -ti CONTAINER sh
373+
```
374+
375+
Where `CONTAINER` is the ID or the name of the container used during its
376+
creation.
377+
363378
## Accessing the GUI
364379
365380
Assuming the container's ports are mapped to the same host's ports, access the
@@ -620,7 +635,7 @@ window to open it.
620635
| **Keyboard** icon | Toggle the on-screen keyboard. Visible only on touch devices. |
621636
| **Fullscreen** icon | Toggle fullscreen mode for the browser window. |
622637
| **Hand** icon| Allows dragging/moving the application window. Visible only when **Scaling Mode** is *None* and **Clip to Window** is enabled.
623-
| **Folder** icon | Opens the intgegrated file browser. Visible only when the [file manager](#web-file-manager) is enabled. |
638+
| **Folder** icon | Opens the integrated file browser. Visible only when the [file manager](#web-file-manager) is enabled. |
624639
| **Terminal** icon | Opens the integrated terminal. Visibile only when the [terminal](#web-terminal) is enabled. |
625640
| **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. |
626641
| **Clear** button | Clears the clipboard. Hidden when [automatic clipboard synchronization](#automatic-clipboard-sync) is active. |
@@ -730,7 +745,7 @@ configuring environment variables.
730745
> [!NOTE]
731746
> This feature is not available to VNC clients.
732747
733-
### Web Terminal
748+
## Web Terminal
734749
735750
The container includes a web-based terminal, allowing users to easily obtain
736751
shell access to the running container through a web browser.
@@ -768,17 +783,6 @@ drivers installed, and the GPU device `/dev/dri` must be exposed to the
768783
container. For example, this is done by adding the `--device /dev/dri`
769784
argument to the `docker run` command.
770785
771-
## Shell Access
772-
773-
To access the shell of a running container, execute the following command:
774-
775-
```shell
776-
docker exec -ti CONTAINER sh
777-
```
778-
779-
Where `CONTAINER` is the ID or the name of the container used during its
780-
creation.
781-
782786
## Allowing the membarrier System Call
783787
784788
To properly work, recent versions of Firefox need the

0 commit comments

Comments
 (0)