wood/docker-firefox
1
0
Fork 0
mirror of https://github.com/woodchen-ink/docker-firefox.git synced 2025-07-19 14:21:59 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated README.

Browse Source
This commit is contained in:
Jocelyn Le Sage 2024-08-30 22:26:31 -04:00
parent 36de296a7c
commit 0279b73a36
1 changed files with 25 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -55,9 +55,9 @@ Foundation and its subsidiary, Mozilla Corporation.
## Quick Start ## Quick Start
**NOTE**: > [!IMPORTANT]
The Docker command provided in this quick start is given as an example > The Docker command provided in this quick start is given as an example and
and parameters should be adjusted to your need. > parameters should be adjusted to your need.
Launch the Firefox docker container with the following command: Launch the Firefox docker container with the following command:
```shell ```shell
@ -217,11 +217,11 @@ docker rm firefox
3. Create/start the container using the `docker run` command, by adjusting 3. Create/start the container using the `docker run` command, by adjusting
parameters as needed. parameters as needed.
**NOTE**: > [!NOTE]
Since all application's data is saved under the `/config` container > Since all application's data is saved under the `/config` container folder,
folder, destroying and re-creating a container is not a problem: nothing is > destroying and re-creating a container is not a problem: nothing is lost and
lost and the application comes back with the same state (as long as the > the application comes back with the same state (as long as the mapping of the
mapping of the `/config` folder remains the same). > `/config` folder remains the same).
## Docker Compose File ## Docker Compose File
@ -409,13 +409,13 @@ PEM encoded, x509 certificates.
|`/config/certs/web-privkey.pem` |HTTPs connection encryption.|Web server's private key.| |`/config/certs/web-privkey.pem` |HTTPs connection encryption.|Web server's private key.|
|`/config/certs/web-fullchain.pem`|HTTPs connection encryption.|Web server's certificate, bundled with any root and intermediate certificates.| |`/config/certs/web-fullchain.pem`|HTTPs connection encryption.|Web server's certificate, bundled with any root and intermediate certificates.|
**NOTE**: > [!TIP]
To prevent any certificate validity warnings/errors from the browser > To prevent any certificate validity warnings/errors from the browser or VNC
or VNC client, make sure to supply your own valid certificates. > client, make sure to supply your own valid certificates.
**NOTE**: > [!NOTE]
Certificate files are monitored and relevant daemons are automatically > Certificate files are monitored and relevant daemons are automatically
restarted when changes are detected. > restarted when changes are detected.
### VNC Password ### VNC Password
@ -433,11 +433,11 @@ The level of security provided by the VNC password depends on two things:
When using a VNC password, it is highly desirable to enable the secure When using a VNC password, it is highly desirable to enable the secure
connection to prevent sending the password in clear over an unencrypted channel. connection to prevent sending the password in clear over an unencrypted channel.
**ATTENTION**: > [!CAUTION]
Password is limited to 8 characters. This limitation comes from > Password is limited to 8 characters. This limitation comes from the Remote
the Remote Framebuffer Protocol [RFC](https://tools.ietf.org/html/rfc6143) > Framebuffer Protocol [RFC](https://tools.ietf.org/html/rfc6143) (see section
(see section [7.2.2](https://tools.ietf.org/html/rfc6143#section-7.2.2)). > [7.2.2](https://tools.ietf.org/html/rfc6143#section-7.2.2)). Any characters
Any characters beyond the limit are ignored. > beyond the limit are ignored.
### Web Authentication ### Web Authentication
@ -451,8 +451,9 @@ environment variable to `1`.
See the [Environment Variables](#environment-variables) section for more details See the [Environment Variables](#environment-variables) section for more details
on how to set an environment variable. on how to set an environment variable.
**NOTE**: Secure connection must be also enabled to use web authentication. > [!IMPORTANT]
See the [Security](#security) section for more details. > Secure connection must also be enabled to use web authentication.
> See the [Security](#security) section for more details.
#### Configuring Users Credentials #### Configuring Users Credentials
@ -568,6 +569,9 @@ server {
location = /firefox {return 301 $scheme://$http_host/firefox/;} location = /firefox {return 301 $scheme://$http_host/firefox/;}
location /firefox/ { location /firefox/ {
proxy_pass http://docker-firefox/; proxy_pass http://docker-firefox/;
# Uncomment the following line if your Nginx server runs on a port that
# differs from the one seen by external clients.
#port_in_redirect off;
location /firefox/websockify { location /firefox/websockify {
proxy_pass http://docker-firefox/websockify/; proxy_pass http://docker-firefox/websockify/;
proxy_http_version 1.1; proxy_http_version 1.1;