Added missing language to code blocks and adjusted notes for better compatibility with mkdocs.

This commit is contained in:
Jocelyn Le Sage 2023-08-19 15:50:22 -04:00
parent 90f0b4fc60
commit 96aa2a1a5f
2 changed files with 40 additions and 27 deletions

View File

@ -23,8 +23,9 @@ Foundation and its subsidiary, Mozilla Corporation.
## Quick Start ## Quick Start
**NOTE**: The Docker command provided in this quick start is given as an example **NOTE**:
and parameters should be adjusted to your need. The Docker command provided in this quick start is given as an example
and 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
@ -36,6 +37,7 @@ docker run -d \
``` ```
Where: Where:
- `/docker/appdata/firefox`: This is where the application stores its configuration, states, log and any files needing persistency. - `/docker/appdata/firefox`: This is where the application stores its configuration, states, log and any files needing persistency.
Browse to `http://your-host-ip:5800` to access the Firefox GUI. Browse to `http://your-host-ip:5800` to access the Firefox GUI.

View File

@ -53,8 +53,9 @@ Foundation and its subsidiary, Mozilla Corporation.
## Quick Start ## Quick Start
**NOTE**: The Docker command provided in this quick start is given as an example **NOTE**:
and parameters should be adjusted to your need. The Docker command provided in this quick start is given as an example
and 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
@ -66,6 +67,7 @@ docker run -d \
``` ```
Where: Where:
- `/docker/appdata/firefox`: This is where the application stores its configuration, states, log and any files needing persistency. - `/docker/appdata/firefox`: This is where the application stores its configuration, states, log and any files needing persistency.
Browse to `http://your-host-ip:5800` to access the Firefox GUI. Browse to `http://your-host-ip:5800` to access the Firefox GUI.
@ -195,20 +197,23 @@ parameter(s) of an existing container. The general idea is to destroy and
re-create the container: re-create the container:
1. Stop the container (if it is running): 1. Stop the container (if it is running):
``` ```shell
docker stop firefox docker stop firefox
``` ```
2. Remove the container: 2. Remove the container:
``` ```shell
docker rm firefox 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**: Since all application's data is saved under the `/config` container **NOTE**:
folder, destroying and re-creating a container is not a problem: nothing is lost Since all application's data is saved under the `/config` container
and the application comes back with the same state (as long as the mapping of folder, destroying and re-creating a container is not a problem: nothing is
the `/config` folder remains the same). lost and the application comes back with the same state (as long as the
mapping of the `/config` folder remains the same).
## Docker Compose File ## Docker Compose File
@ -259,17 +264,20 @@ Watchtower will seamlessly perform the necessary steps to update the container.
Finally, the Docker image can be manually updated with these steps: Finally, the Docker image can be manually updated with these steps:
1. Fetch the latest image: 1. Fetch the latest image:
``` ```shell
docker pull jlesage/firefox docker pull jlesage/firefox
``` ```
2. Stop the container: 2. Stop the container:
``` ```shell
docker stop firefox docker stop firefox
``` ```
3. Remove the container: 3. Remove the container:
``` ```shell
docker rm firefox docker rm firefox
``` ```
4. Create and start the container using the `docker run` command, with the 4. Create and start the container using the `docker run` command, with the
the same parameters that were used when it was deployed initially. the same parameters that were used when it was deployed initially.
@ -320,7 +328,7 @@ user owning the data volume on the host:
id <username> id <username>
Which gives an output like this one: Which gives an output like this one:
``` ```text
uid=1000(myuser) gid=1000(myuser) groups=1000(myuser),4(adm),24(cdrom),27(sudo),46(plugdev),113(lpadmin) uid=1000(myuser) gid=1000(myuser) groups=1000(myuser),4(adm),24(cdrom),27(sudo),46(plugdev),113(lpadmin)
``` ```
@ -334,13 +342,13 @@ graphical interface of the application can be accessed via:
* A web browser: * A web browser:
``` ```text
http://<HOST IP ADDR>:5800 http://<HOST IP ADDR>:5800
``` ```
* Any VNC client: * Any VNC client:
``` ```text
<HOST IP ADDR>:5900 <HOST IP ADDR>:5900
``` ```
@ -369,7 +377,7 @@ few VNC clients support this method. [SSVNC] is one of them.
While the Linux version of [SSVNC] works well, the Windows version has some While the Linux version of [SSVNC] works well, the Windows version has some
issues. At the time of writing, the latest version `1.0.30` is not functional, issues. At the time of writing, the latest version `1.0.30` is not functional,
as a connection fails with the following error: as a connection fails with the following error:
``` ```text
ReadExact: Socket error while reading ReadExact: Socket error while reading
``` ```
However, for your convenience, an unofficial and working version is provided However, for your convenience, an unofficial and working version is provided
@ -393,11 +401,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**: To prevent any certificate validity warnings/errors from the browser **NOTE**:
or VNC client, make sure to supply your own valid certificates. To prevent any certificate validity warnings/errors from the browser
or VNC client, make sure to supply your own valid certificates.
**NOTE**: Certificate files are monitored and relevant daemons are automatically **NOTE**:
restarted when changes are detected. Certificate files are monitored and relevant daemons are automatically
restarted when changes are detected.
### VNC Password ### VNC Password
@ -415,10 +425,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**: Password is limited to 8 characters. This limitation comes from **ATTENTION**:
the Remote Framebuffer Protocol [RFC](https://tools.ietf.org/html/rfc6143) (see Password is limited to 8 characters. This limitation comes from
section [7.2.2](https://tools.ietf.org/html/rfc6143#section-7.2.2)). Any the Remote Framebuffer Protocol [RFC](https://tools.ietf.org/html/rfc6143)
characters beyond the limit are ignored. (see section [7.2.2](https://tools.ietf.org/html/rfc6143#section-7.2.2)).
Any characters beyond the limit are ignored.
## Reverse Proxy ## Reverse Proxy
@ -439,7 +450,7 @@ as this container. The server would proxy all HTTP requests sent to
Here are the relevant configuration elements that would be added to the NGINX Here are the relevant configuration elements that would be added to the NGINX
configuration: configuration:
``` ```nginx
map $http_upgrade $connection_upgrade { map $http_upgrade $connection_upgrade {
default upgrade; default upgrade;
'' close; '' close;
@ -485,7 +496,7 @@ as this container. The server would proxy all HTTP requests for
Here are the relevant configuration elements that would be added to the NGINX Here are the relevant configuration elements that would be added to the NGINX
configuration: configuration:
``` ```nginx
map $http_upgrade $connection_upgrade { map $http_upgrade $connection_upgrade {
default upgrade; default upgrade;
'' close; '' close;