mirror of
https://github.com/woodchen-ink/docker-firefox.git
synced 2025-07-18 13:52:02 +08:00
Initial code drop.
This commit is contained in:
commit
1447b6640a
18
.travis.yml
Normal file
18
.travis.yml
Normal file
@ -0,0 +1,18 @@
|
||||
#
|
||||
# Travis CI recipe to build docker image.
|
||||
#
|
||||
|
||||
sudo: required
|
||||
|
||||
language: generic
|
||||
|
||||
services:
|
||||
- docker
|
||||
|
||||
before_script:
|
||||
- echo "Validating Dockerfile..."
|
||||
- docker run --rm -v "$(pwd)/Dockerfile:/Dockerfile:ro" redcoolbeans/dockerlint:0.2.0
|
||||
|
||||
script:
|
||||
- echo "Starting build of Docker image..."
|
||||
- docker build --no-cache --pull -t $TRAVIS_REPO_SLUG:$TRAVIS_JOB_ID .
|
89
Dockerfile
Normal file
89
Dockerfile
Normal file
@ -0,0 +1,89 @@
|
||||
#
|
||||
# firefox Dockerfile
|
||||
#
|
||||
# https://github.com/jlesage/docker-firefox
|
||||
#
|
||||
|
||||
# Pull base image.
|
||||
FROM jlesage/baseimage-gui:alpine-3.7-v3.3.2
|
||||
|
||||
# Define software versions.
|
||||
ARG FIREFOX_VERSION=58.0.1-r1
|
||||
#ARG PROFILE_CLEANER_VERSION=2.36
|
||||
|
||||
# Define software download URLs.
|
||||
#ARG PROFILE_CLEANER_URL=https://github.com/graysky2/profile-cleaner/raw/v${PROFILE_CLEANER_VERSION}/common/profile-cleaner.in
|
||||
|
||||
# Define working directory.
|
||||
WORKDIR /tmp
|
||||
|
||||
# Install Firefox.
|
||||
RUN \
|
||||
add-pkg firefox=${FIREFOX_VERSION} --repository http://dl-cdn.alpinelinux.org/alpine/edge/testing && \
|
||||
add-pkg \
|
||||
desktop-file-utils \
|
||||
adwaita-icon-theme \
|
||||
ttf-dejavu
|
||||
|
||||
# Set default settings.
|
||||
RUN \
|
||||
CFG_FILE="$(ls /usr/lib/firefox-*/browser/defaults/preferences/firefox-branding.js)" && \
|
||||
echo '' >> "$CFG_FILE" && \
|
||||
echo '// Default download directory.' >> "$CFG_FILE" && \
|
||||
echo 'pref("browser.download.dir", "/config/downloads");' >> "$CFG_FILE" && \
|
||||
echo 'pref("browser.download.folderList", 2);' >> "$CFG_FILE"
|
||||
|
||||
# Install profile-cleaner.
|
||||
#RUN \
|
||||
# add-pkg --virtual build-dependencies curl && \
|
||||
# curl -# -L -o /usr/bin/profile-cleaner {$PROFILE_CLEANER_URL} && \
|
||||
# sed-patch 's/@VERSION@/'${PROFILE_CLEANER_VERSION}'/' /usr/bin/profile-cleaner && \
|
||||
# chmod +x /usr/bin/profile-cleaner && \
|
||||
# add-pkg \
|
||||
# bash \
|
||||
# file \
|
||||
# coreutils \
|
||||
# bc \
|
||||
# parallel \
|
||||
# sqlite \
|
||||
# && \
|
||||
# # Cleanup.
|
||||
# del-pkg build-dependencies && \
|
||||
# rm -rf /tmp/* /tmp/.[!.]*
|
||||
|
||||
# Enable log monitoring.
|
||||
RUN \
|
||||
add-pkg yad && \
|
||||
sed-patch 's|LOG_FILES=|LOG_FILES=/config/log/firefox/error.log|' /etc/logmonitor/logmonitor.conf && \
|
||||
sed-patch 's|STATUS_FILES=|STATUS_FILES=/tmp/.firefox_shm_check|' /etc/logmonitor/logmonitor.conf
|
||||
|
||||
# Adjust the openbox config.
|
||||
RUN \
|
||||
# Maximize only the main window.
|
||||
sed-patch 's/<application type="normal">/<application type="normal" title="Mozilla Firefox">/' \
|
||||
/etc/xdg/openbox/rc.xml && \
|
||||
# Make sure the main window is always in the background.
|
||||
sed-patch '/<application type="normal" title="Mozilla Firefox">/a \ <layer>below</layer>' \
|
||||
/etc/xdg/openbox/rc.xml
|
||||
|
||||
# Generate and install favicons.
|
||||
RUN \
|
||||
APP_ICON_URL=https://github.com/jlesage/docker-templates/raw/master/jlesage/images/firefox-icon.png && \
|
||||
install_app_icon.sh "$APP_ICON_URL"
|
||||
|
||||
# Add files.
|
||||
COPY rootfs/ /
|
||||
|
||||
# Set environment variables.
|
||||
ENV APP_NAME="Firefox"
|
||||
|
||||
# Define mountable directories.
|
||||
VOLUME ["/config"]
|
||||
|
||||
# Metadata.
|
||||
LABEL \
|
||||
org.label-schema.name="firefox" \
|
||||
org.label-schema.description="Docker container for Firefox" \
|
||||
org.label-schema.version="unknown" \
|
||||
org.label-schema.vcs-url="https://github.com/jlesage/docker-firefox" \
|
||||
org.label-schema.schema-version="1.0"
|
413
README.md
Normal file
413
README.md
Normal file
@ -0,0 +1,413 @@
|
||||
# Docker container for Firefox
|
||||
[](https://hub.docker.com/r/jlesage/firefox/) [](http://microbadger.com/#/images/jlesage/firefox) [](https://travis-ci.org/jlesage/docker-firefox) [](https://github.com/jlesage/docker-firefox/releases/latest) [](https://paypal.me/JocelynLeSage)
|
||||
|
||||
This is a Docker container for Firefox.
|
||||
|
||||
The GUI of the application is accessed through a modern web browser (no installation or configuration needed on client side) or via any VNC client.
|
||||
|
||||
---
|
||||
|
||||
[](https://www.mozilla.org/en-US/firefox/)[](https://www.mozilla.org/en-US/firefox/)
|
||||
|
||||
Mozilla Firefox is a free and open-source web browser developed by Mozilla Foundation and its subsidiary, Mozilla Corporation.
|
||||
|
||||
---
|
||||
|
||||
## Table of Content
|
||||
|
||||
* [Docker container for Firefox](#docker-container-for-firefox)
|
||||
* [Table of Content](#table-of-content)
|
||||
* [Quick Start](#quick-start)
|
||||
* [Usage](#usage)
|
||||
* [Environment Variables](#environment-variables)
|
||||
* [Data Volumes](#data-volumes)
|
||||
* [Ports](#ports)
|
||||
* [Changing Parameters of a Running Container](#changing-parameters-of-a-running-container)
|
||||
* [Docker Compose File](#docker-compose-file)
|
||||
* [Docker Image Update](#docker-image-update)
|
||||
* [User/Group IDs](#usergroup-ids)
|
||||
* [Accessing the GUI](#accessing-the-gui)
|
||||
* [Security](#security)
|
||||
* [Certificates](#certificates)
|
||||
* [VNC Password](#vnc-password)
|
||||
* [Increasing Shared Memory Size](#increasing-shared-memory-size)
|
||||
* [Troubleshooting](#troubleshooting)
|
||||
* [Crashes](#crashes)
|
||||
* [Reverse Proxy](#reverse-proxy)
|
||||
* [Routing Based on Hostname](#routing-based-on-hostname)
|
||||
* [Routing Based on URL Path](#routing-based-on-url-path)
|
||||
* [Support or Contact](#support-or-contact)
|
||||
|
||||
## Quick Start
|
||||
|
||||
**NOTE**: 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:
|
||||
```
|
||||
docker run -d \
|
||||
--name=firefox \
|
||||
-p 5800:5800 \
|
||||
-v /docker/appdata/firefox:/config:rw \
|
||||
--shm-size 2g \
|
||||
jlesage/firefox
|
||||
```
|
||||
|
||||
Where:
|
||||
- `/docker/appdata/firefox`: This is where the application stores its configuration, log and any files needing persistency.
|
||||
|
||||
Browse to `http://your-host-ip:5800` to access the Firefox GUI. Files from
|
||||
the host appear under the `/storage` folder in the container.
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
docker run [-d] \
|
||||
--name=firefox \
|
||||
[-e <VARIABLE_NAME>=<VALUE>]... \
|
||||
[-v <HOST_DIR>:<CONTAINER_DIR>[:PERMISSIONS]]... \
|
||||
[-p <HOST_PORT>:<CONTAINER_PORT>]... \
|
||||
--shm-size VALUE \
|
||||
jlesage/firefox
|
||||
```
|
||||
| Parameter | Description |
|
||||
|-----------|-------------|
|
||||
| -d | Run the container in background. If not set, the container runs in foreground. |
|
||||
| -e | Pass an environment variable to the container. See the [Environment Variables](#environment-variables) section for more details. |
|
||||
| -v | Set a volume mapping (allows to share a folder/file between the host and the container). See the [Data Volumes](#data-volumes) section for more details. |
|
||||
| -p | Set a network port mapping (exposes an internal container port to the host). See the [Ports](#ports) section for more details. |
|
||||
| --shm-size | Set the size of `/dev/shm` to `VALUE`. The format of `VALUE` is `<number><unit>`, where `number` must be greater than `0` and `unit` can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g` (gigabytes). **NOTE**: To avoid crashes, it is recommended to set this value to `2g`. |
|
||||
|
||||
### Environment Variables
|
||||
|
||||
To customize some properties of the container, the following environment
|
||||
variables can be passed via the `-e` parameter (one for each variable). Value
|
||||
of this parameter has the format `<VARIABLE_NAME>=<VALUE>`.
|
||||
|
||||
| Variable | Description | Default |
|
||||
|----------------|----------------------------------------------|---------|
|
||||
|`USER_ID`| ID of the user the application runs as. See [User/Group IDs](#usergroup-ids) to better understand when this should be set. | `1000` |
|
||||
|`GROUP_ID`| ID of the group the application runs as. See [User/Group IDs](#usergroup-ids) to better understand when this should be set. | `1000` |
|
||||
|`SUP_GROUP_IDS`| Comma-separated list of supplementary group IDs of the application. | (unset) |
|
||||
|`UMASK`| Mask that controls how file permissions are set for newly created files. The value of the mask is in octal notation. By default, this variable is not set and the default umask of `022` is used, meaning that newly created files are readable by everyone, but only writable by the owner. See the following online umask calculator: http://wintelguy.com/umask-calc.pl | (unset) |
|
||||
|`TZ`| [TimeZone] of the container. Timezone can also be set by mapping `/etc/localtime` between the host and the container. | `Etc/UTC` |
|
||||
|`KEEP_APP_RUNNING`| When set to `1`, the application will be automatically restarted if it crashes or if user quits it. | `0` |
|
||||
|`APP_NICENESS`| Priority at which the application should run. A niceness value of -20 is the highest priority and 19 is the lowest priority. By default, niceness is not set, meaning that the default niceness of 0 is used. **NOTE**: A negative niceness (priority increase) requires additional permissions. In this case, the container should be run with the docker option `--cap-add=SYS_NICE`. | (unset) |
|
||||
|`CLEAN_TMP_DIR`| When set to `1`, all files in the `/tmp` directory are delete during the container startup. | `1` |
|
||||
|`DISPLAY_WIDTH`| Width (in pixels) of the application's window. | `1280` |
|
||||
|`DISPLAY_HEIGHT`| Height (in pixels) of the application's window. | `768` |
|
||||
|`SECURE_CONNECTION`| When set to `1`, an encrypted connection is used to access the application's GUI (either via web browser or VNC client). See the [Security](#security) section for more details. | `0` |
|
||||
|`VNC_PASSWORD`| Password needed to connect to the application's GUI. See the [VNC Password](#vnc-password) section for more details. | (unset) |
|
||||
|`X11VNC_EXTRA_OPTS`| Extra options to pass to the x11vnc server running in the Docker container. **WARNING**: For advanced users. Do not use unless you know what you are doing. | (unset) |
|
||||
|`ENABLE_CJK_FONT`| When set to `1`, open source computer font `WenQuanYi Zen Hei` is installed. This font contains a large range of Chinese/Japanese/Korean characters. | `0` |
|
||||
|
||||
### Data Volumes
|
||||
|
||||
The following table describes data volumes used by the container. The mappings
|
||||
are set via the `-v` parameter. Each mapping is specified with the following
|
||||
format: `<HOST_DIR>:<CONTAINER_DIR>[:PERMISSIONS]`.
|
||||
|
||||
| Container path | Permissions | Description |
|
||||
|-----------------|-------------|-------------|
|
||||
|`/config`| rw | This is where the application stores its configuration, log and any files needing persistency. |
|
||||
|
||||
### Ports
|
||||
|
||||
Here is the list of ports used by the container. They can be mapped to the host
|
||||
via the `-p` parameter (one per port mapping). Each mapping is defined in the
|
||||
following format: `<HOST_PORT>:<CONTAINER_PORT>`. The port number inside the
|
||||
container cannot be changed, but you are free to use any port on the host side.
|
||||
|
||||
| Port | Mapping to host | Description |
|
||||
|------|-----------------|-------------|
|
||||
| 5800 | Mandatory | Port used to access the application's GUI via the web interface. |
|
||||
| 5900 | Optional | Port used to access the application's GUI via the VNC protocol. Optional if no VNC client is used. |
|
||||
|
||||
### Changing Parameters of a Running Container
|
||||
|
||||
As seen, environment variables, volume mappings and port mappings are specified
|
||||
while creating the container.
|
||||
|
||||
The following steps describe the method used to add, remove or update
|
||||
parameter(s) of an existing container. The generic idea is to destroy and
|
||||
re-create the container:
|
||||
|
||||
1. Stop the container (if it is running):
|
||||
```
|
||||
docker stop firefox
|
||||
```
|
||||
2. Remove the container:
|
||||
```
|
||||
docker rm firefox
|
||||
```
|
||||
3. Create/start the container using the `docker run` command, by adjusting
|
||||
parameters as needed.
|
||||
|
||||
**NOTE**: Since all application's data is saved under the `/config` container
|
||||
folder, destroying and re-creating a container is not a problem: nothing is 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
|
||||
|
||||
Here is an example of a `docker-compose.yml` file that can be used with
|
||||
[Docker Compose](https://docs.docker.com/compose/overview/).
|
||||
|
||||
Make sure to adjust according to your needs. Note that only mandatory network
|
||||
ports are part of the example.
|
||||
|
||||
```yaml
|
||||
version: '3'
|
||||
services:
|
||||
firefox:
|
||||
build: .
|
||||
ports:
|
||||
- "5800:5800"
|
||||
volumes:
|
||||
- "/docker/appdata/firefox:/config:rw"
|
||||
```
|
||||
|
||||
## Docker Image Update
|
||||
|
||||
If the system on which the container runs doesn't provide a way to easily update
|
||||
the Docker image, the following steps can be followed:
|
||||
|
||||
1. Fetch the latest image:
|
||||
```
|
||||
docker pull jlesage/firefox
|
||||
```
|
||||
2. Stop the container:
|
||||
```
|
||||
docker stop firefox
|
||||
```
|
||||
3. Remove the container:
|
||||
```
|
||||
docker rm firefox
|
||||
```
|
||||
4. Start the container using the `docker run` command.
|
||||
|
||||
## User/Group IDs
|
||||
|
||||
When using data volumes (`-v` flags), permissions issues can occur between the
|
||||
host and the container. For example, the user within the container may not
|
||||
exists on the host. This could prevent the host from properly accessing files
|
||||
and folders on the shared volume.
|
||||
|
||||
To avoid any problem, you can specify the user the application should run as.
|
||||
|
||||
This is done by passing the user ID and group ID to the container via the
|
||||
`USER_ID` and `GROUP_ID` environment variables.
|
||||
|
||||
To find the right IDs to use, issue the following command on the host, with the
|
||||
user owning the data volume on the host:
|
||||
|
||||
id <username>
|
||||
|
||||
Which gives an output like this one:
|
||||
```
|
||||
uid=1000(myuser) gid=1000(myuser) groups=1000(myuser),4(adm),24(cdrom),27(sudo),46(plugdev),113(lpadmin)
|
||||
```
|
||||
|
||||
The value of `uid` (user ID) and `gid` (group ID) are the ones that you should
|
||||
be given the container.
|
||||
|
||||
## Accessing the GUI
|
||||
|
||||
Assuming that container's ports are mapped to the same host's ports, the
|
||||
graphical interface of the application can be accessed via:
|
||||
|
||||
* A web browser:
|
||||
```
|
||||
http://<HOST IP ADDR>:5800
|
||||
```
|
||||
|
||||
* Any VNC client:
|
||||
```
|
||||
<HOST IP ADDR>:5900
|
||||
```
|
||||
|
||||
## Security
|
||||
|
||||
By default, access to the application's GUI is done over an unencrypted
|
||||
connection (HTTP or VNC).
|
||||
|
||||
Secure connection can be enabled via the `SECURE_CONNECTION` environment
|
||||
variable. See the [Environment Variables](#environment-variables) section for
|
||||
more details on how to set an environment variable.
|
||||
|
||||
When enabled, application's GUI is performed over an HTTPs connection when
|
||||
accessed with a browser. All HTTP accesses are automatically redirected to
|
||||
HTTPs.
|
||||
|
||||
When using a VNC client, the VNC connection is performed over SSL. Note that
|
||||
few VNC clients support this method. [SSVNC] is one of them.
|
||||
|
||||
### Certificates
|
||||
|
||||
Here are the certificate files needed by the container. By default, when they
|
||||
are missing, self-signed certificates are generated and used. All files have
|
||||
PEM encoded, x509 certificates.
|
||||
|
||||
| Container Path | Purpose | Content |
|
||||
|---------------------------------|----------------------------|---------|
|
||||
|`/config/certs/vnc-server.pem` |VNC connection encryption. |VNC server's private key and certificate, bundled with any root and intermediate certificates.|
|
||||
|`/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.|
|
||||
|
||||
**NOTE**: 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
|
||||
restarted when changes are detected.
|
||||
|
||||
### VNC Password
|
||||
|
||||
To restrict access to your application, a password can be specified. This can
|
||||
be done via two methods:
|
||||
* By using the `VNC_PASSWORD` environment variable.
|
||||
* By creating a `.vncpass_clear` file at the root of the `/config` volume.
|
||||
This file should contains the password in clear-text. During the container
|
||||
startup, content of the file is obfuscated and moved to `.vncpass`.
|
||||
|
||||
The level of security provided by the VNC password depends on two things:
|
||||
* The type of communication channel (encrypted/unencrypted).
|
||||
* How secure access to the host is.
|
||||
|
||||
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.
|
||||
|
||||
**ATTENTION**: Password is limited to 8 characters. This limitation comes from
|
||||
the Remote Framebuffer Protocol [RFC](https://tools.ietf.org/html/rfc6143) (see
|
||||
section [7.2.2](https://tools.ietf.org/html/rfc6143#section-7.2.2)). Any
|
||||
characters beyhond the limit are ignored.
|
||||
|
||||
## Increasing Shared Memory Size
|
||||
|
||||
To prevent crashes from happening when running Firefox
|
||||
inside a Docker container, the size of the shared memory located at `/dev/shm`
|
||||
must be increased. The issue is documented [here].
|
||||
|
||||
By default, the size is 64MB, which is not enough. It is recommended to use a
|
||||
size of 2GB. This value is arbitrary, but known to work well. Setting the
|
||||
size of `/dev/shm` can be done via two method:
|
||||
|
||||
- By adding the `--shm-size=2g` parameter to the `docker run` command. See
|
||||
the [Usage](#usage) section for more details.
|
||||
- By using shared memory of the host, by mapping `/dev/shm` via the parameter
|
||||
`-v /dev/shm:/dev/shm` of the `docker run` command.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Crashes
|
||||
|
||||
If Firefox is crashing frequently, make sure the size of
|
||||
the shared memory located at `/dev/shm` has been increased. See
|
||||
[Increasing Shared Memory Size](#increasing-shared-memory-size) section for more
|
||||
details.
|
||||
|
||||
[TimeZone]: http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
[here]: https://bugzilla.mozilla.org/show_bug.cgi?id=1338771#c10
|
||||
|
||||
## Reverse Proxy
|
||||
|
||||
The following sections contains NGINX configuration that need to be added in
|
||||
order to reverse proxy to this container.
|
||||
|
||||
A reverse proxy server can route HTTP requests based on the hostname or the URL
|
||||
path.
|
||||
|
||||
### Routing Based on Hostname
|
||||
|
||||
In this scenario, each hostname is routed to a different application/container.
|
||||
|
||||
For example, let's say the reverse proxy server is running on the same machine
|
||||
as this container. The server would proxy all HTTP requests sent to
|
||||
`firefox.domain.tld` to the container at `127.0.0.1:5800`.
|
||||
|
||||
Here are the relevant configuration elements that would be added to the NGINX
|
||||
configuration:
|
||||
|
||||
```
|
||||
map $http_upgrade $connection_upgrade {
|
||||
default upgrade;
|
||||
'' close;
|
||||
}
|
||||
|
||||
upstream docker-firefox {
|
||||
# If the reverse proxy server is not running on the same machine as the
|
||||
# Docker container, use the IP of the Docker host here.
|
||||
# Make sure to adjust the port according to how port 5800 of the
|
||||
# container has been mapped on the host.
|
||||
server 127.0.0.1:5800;
|
||||
}
|
||||
|
||||
server {
|
||||
[...]
|
||||
|
||||
server_name firefox.domain.tld;
|
||||
|
||||
location / {
|
||||
proxy_pass http://docker-firefox;
|
||||
}
|
||||
|
||||
location /websockify {
|
||||
proxy_pass http://docker-firefox;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection $connection_upgrade;
|
||||
proxy_read_timeout 86400;
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
### Routing Based on URL Path
|
||||
|
||||
In this scenario, the hostname is the same, but different URL paths are used to
|
||||
route to different applications/containers.
|
||||
|
||||
For example, let's say the reverse proxy server is running on the same machine
|
||||
as this container. The server would proxy all HTTP requests for
|
||||
`server.domain.tld/firefox` to the container at `127.0.0.1:5800`.
|
||||
|
||||
Here are the relevant configuration elements that would be added to the NGINX
|
||||
configuration:
|
||||
|
||||
```
|
||||
map $http_upgrade $connection_upgrade {
|
||||
default upgrade;
|
||||
'' close;
|
||||
}
|
||||
|
||||
upstream docker-firefox {
|
||||
# If the reverse proxy server is not running on the same machine as the
|
||||
# Docker container, use the IP of the Docker host here.
|
||||
# Make sure to adjust the port according to how port 5800 of the
|
||||
# container has been mapped on the host.
|
||||
server 127.0.0.1:5800;
|
||||
}
|
||||
|
||||
server {
|
||||
[...]
|
||||
|
||||
location = /firefox {return 301 $scheme://$http_host/firefox/;}
|
||||
location /firefox/ {
|
||||
proxy_pass http://docker-firefox/;
|
||||
location /firefox/websockify {
|
||||
proxy_pass http://docker-firefox/websockify/;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection $connection_upgrade;
|
||||
proxy_read_timeout 86400;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## Support or Contact
|
||||
|
||||
Having troubles with the container or have questions? Please
|
||||
[create a new issue].
|
||||
|
||||
[create a new issue]: https://github.com/jlesage/docker-firefox/issues
|
39
hooks/post_push
Executable file
39
hooks/post_push
Executable file
@ -0,0 +1,39 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Post push hook for Docker Automated Build.
|
||||
#
|
||||
# This hook adds the 'latest' tag to the image.
|
||||
#
|
||||
|
||||
set -e # Exit immediately if a command exits with a non-zero status.
|
||||
set -u # Treat unset variables as an error.
|
||||
|
||||
source custom_hook_env
|
||||
|
||||
echo "Environment variables:
|
||||
IMAGE_NAME=$IMAGE_NAME
|
||||
DOCKER_REPO=$DOCKER_REPO
|
||||
DOCKER_TAG=$DOCKER_TAG
|
||||
SOURCE_BRANCH=$SOURCE_BRANCH
|
||||
IMAGE_VERSION=$IMAGE_VERSION
|
||||
"
|
||||
|
||||
if [[ "$DOCKER_TAG" =~ v[0-9]+\.[0-9]+\.[0-9]+-alpha[0-9]+$ ]]; then
|
||||
DOCKER_NEWTAG="$(echo "$DOCKER_TAG" | sed 's/-alpha[0-9]\+$/-alpha/')"
|
||||
elif [[ "$DOCKER_TAG" =~ v[0-9]+\.[0-9]+\.[0-9]+-beta[0-9]+$ ]]; then
|
||||
DOCKER_NEWTAG="$(echo "$DOCKER_TAG" | sed 's/-beta[0-9]\+$/-beta/')"
|
||||
elif [[ "$DOCKER_TAG" =~ v[0-9]+\.[0-9]+\.[0-9]+-rc[0-9]+$ ]]; then
|
||||
DOCKER_NEWTAG="$(echo "$DOCKER_TAG" | sed 's/-rc[0-9]\+$/-rc/')"
|
||||
elif [[ "$DOCKER_TAG" =~ v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
|
||||
DOCKER_NEWTAG="latest"
|
||||
else
|
||||
echo "ERROR: Invalid docker tag."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Adding tag '$DOCKER_NEWTAG' to image..."
|
||||
docker tag $IMAGE_NAME ${DOCKER_REPO}:$DOCKER_NEWTAG
|
||||
echo "Pushing image..."
|
||||
docker push ${DOCKER_REPO}:$DOCKER_NEWTAG
|
||||
|
||||
echo "post_push hook terminated successfully."
|
38
hooks/pre_build
Executable file
38
hooks/pre_build
Executable file
@ -0,0 +1,38 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Pre build hook for Docker Automated Build.
|
||||
#
|
||||
# This hooks modifies the Dockerfile by inserting the image version in the
|
||||
# related label.
|
||||
#
|
||||
|
||||
set -e # Exit immediately if a command exits with a non-zero status.
|
||||
set -u # Treat unset variables as an error.
|
||||
|
||||
# Make sure the DOCKER_TAG has a supported format like:
|
||||
# v1.0.0
|
||||
# v0.1.0-beta1
|
||||
# v2.0.0-rc2
|
||||
if [[ ! "$DOCKER_TAG" =~ ^v[0-9\.]+(-(alpha|beta|rc)[0-9]+)?$ ]]; then
|
||||
echo "Unsupported DOCKER_TAG: $DOCKER_TAG"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# The version to use is the same has the DOCKER_TAG, minus the initial 'v'.
|
||||
IMAGE_VERSION="${DOCKER_TAG:1}"
|
||||
|
||||
# Export our custom variables.
|
||||
echo "IMAGE_VERSION=\"$IMAGE_VERSION\"" >> custom_hook_env
|
||||
|
||||
echo "Environment variables:
|
||||
IMAGE_NAME=$IMAGE_NAME
|
||||
DOCKER_REPO=$DOCKER_REPO
|
||||
DOCKER_TAG=$DOCKER_TAG
|
||||
SOURCE_BRANCH=$SOURCE_BRANCH
|
||||
IMAGE_VERSION=$IMAGE_VERSION
|
||||
"
|
||||
|
||||
echo "Inserting image version in Dockerfile..."
|
||||
sed -i "s/org.label-schema.version=\"unknown\"/org.label-schema.version=\"$IMAGE_VERSION\"/" Dockerfile
|
||||
|
||||
echo "pre_build hook terminated successfully."
|
41
rootfs/etc/cont-init.d/firefox.sh
Executable file
41
rootfs/etc/cont-init.d/firefox.sh
Executable file
@ -0,0 +1,41 @@
|
||||
#!/usr/bin/with-contenv sh
|
||||
|
||||
set -e # Exit immediately if a command exits with a non-zero status.
|
||||
set -u # Treat unset variables as an error.
|
||||
|
||||
log() {
|
||||
echo "[cont-init.d] $(basename $0): $*"
|
||||
}
|
||||
|
||||
# Make sure some directories are created.
|
||||
mkdir -p /config/downloads
|
||||
mkdir -p /config/log/firefox
|
||||
|
||||
# Generate machine id.
|
||||
log "generating machine-id..."
|
||||
cat /proc/sys/kernel/random/uuid | tr -d '-' > /etc/machine-id
|
||||
|
||||
# Verify the size of /dev/shm.
|
||||
SHM_SIZE_MB="$(df -m /dev/shm | tail -n 1 | tr -s ' ' | cut -d ' ' -f2)"
|
||||
if [ "$SHM_SIZE_MB" -eq 64 ]; then
|
||||
echo 'FAIL' > /tmp/.firefox_shm_check
|
||||
else
|
||||
echo 'PASS' > /tmp/.firefox_shm_check
|
||||
fi
|
||||
|
||||
# Clean/optimize Firefox databases.
|
||||
#if [ -d /config/.mozilla/firefox ] && [ -d /config/profile ]; then
|
||||
# [ -f /config/.mozilla/firefox/profiles.ini ] || cp /defaults/profiles.ini /config/.mozilla/firefox/
|
||||
# env HOME=/config /usr/bin/profile-cleaner f
|
||||
#fi
|
||||
|
||||
# Make sure monitored log files exist.
|
||||
for LOG_FILE in /config/log/firefox/error.log
|
||||
do
|
||||
touch "$LOG_FILE"
|
||||
done
|
||||
|
||||
# Take ownership of the config directory content.
|
||||
chown -R $USER_ID:$GROUP_ID /config/*
|
||||
|
||||
# vim: set ft=sh :
|
2
rootfs/etc/logmonitor/notifications.d/shm_size/desc
Executable file
2
rootfs/etc/logmonitor/notifications.d/shm_size/desc
Executable file
@ -0,0 +1,2 @@
|
||||
#!/usr/bin/with-contenv sh
|
||||
echo "$APP_NAME is likely to crash because of the lack of shared memory. Size of shared memory needs to be increased. See the documentation to find out how this can be done."
|
16
rootfs/etc/logmonitor/notifications.d/shm_size/filter
Executable file
16
rootfs/etc/logmonitor/notifications.d/shm_size/filter
Executable file
@ -0,0 +1,16 @@
|
||||
#!/bin/sh
|
||||
|
||||
set -e # Exit immediately if a command exits with a non-zero status.
|
||||
set -u # Treat unset variables as an error.
|
||||
|
||||
LINE="$1"
|
||||
|
||||
if [ "$LINE" = "FAIL" ]; then
|
||||
echo 'ACK' > /tmp/.firefox_shm_check
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# No match found.
|
||||
exit 1
|
||||
|
||||
# vim: set ft=sh :
|
1
rootfs/etc/logmonitor/notifications.d/shm_size/level
Normal file
1
rootfs/etc/logmonitor/notifications.d/shm_size/level
Normal file
@ -0,0 +1 @@
|
||||
WARNING
|
2
rootfs/etc/logmonitor/notifications.d/shm_size/title
Executable file
2
rootfs/etc/logmonitor/notifications.d/shm_size/title
Executable file
@ -0,0 +1,2 @@
|
||||
#!/usr/bin/with-contenv sh
|
||||
echo "$APP_NAME lacks of shared memory."
|
2
rootfs/etc/logmonitor/notifications.d/tab_crash/desc
Executable file
2
rootfs/etc/logmonitor/notifications.d/tab_crash/desc
Executable file
@ -0,0 +1,2 @@
|
||||
#!/usr/bin/with-contenv sh
|
||||
echo "A $APP_NAME tab crashed because of the lack of shared memory. Size of shared memory needs to be increased. See the documentation to find out how this can be done."
|
17
rootfs/etc/logmonitor/notifications.d/tab_crash/filter
Executable file
17
rootfs/etc/logmonitor/notifications.d/tab_crash/filter
Executable file
@ -0,0 +1,17 @@
|
||||
#!/bin/sh
|
||||
|
||||
set -e # Exit immediately if a command exits with a non-zero status.
|
||||
set -u # Treat unset variables as an error.
|
||||
|
||||
LINE="$1"
|
||||
|
||||
#if echo "$LINE" | grep -q "OutOfMemoryError occurred...RESTARTING!"; then
|
||||
if [ "$LINE" = "###!!! [Parent][MessageChannel] Error: (msgtype=0x150084,name=PBrowser::Msg_Destroy) Channel error: cannot send/recv" ]
|
||||
then
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# No match found.
|
||||
exit 1
|
||||
|
||||
# vim: set ft=sh :
|
1
rootfs/etc/logmonitor/notifications.d/tab_crash/level
Normal file
1
rootfs/etc/logmonitor/notifications.d/tab_crash/level
Normal file
@ -0,0 +1 @@
|
||||
ERROR
|
2
rootfs/etc/logmonitor/notifications.d/tab_crash/title
Executable file
2
rootfs/etc/logmonitor/notifications.d/tab_crash/title
Executable file
@ -0,0 +1,2 @@
|
||||
#!/usr/bin/with-contenv sh
|
||||
echo "$APP_NAME lacks of shared memory."
|
4
rootfs/startapp.sh
Executable file
4
rootfs/startapp.sh
Executable file
@ -0,0 +1,4 @@
|
||||
#!/bin/sh
|
||||
export HOME=/config
|
||||
mkdir -p /config/profile
|
||||
exec /usr/bin/firefox --profile /config/profile --setDefaultBrowser >> /config/log/firefox/output.log 2>> /config/log/firefox/error.log
|
Loading…
x
Reference in New Issue
Block a user