restored README and moved to docker.md

Author: FedericoMulas

.dockerignore

@@ -9,6 +9,7 @@ docs
 test
 
 # unused script and files
+README.md
 alive.bat
 browsers.ini.sample
 centos_install.sh

Dockerfile

@@ -18,15 +18,7 @@ FROM ubuntu:22.04 as production
 ARG TIMEZONE=UTC
 
 ### UPDATE ###
-RUN apt update
-
-### COPYING ENTIRE DIR TO LOCAL DOCKER /wptagent ###
-# see .dockerignore for filterd out folders
-COPY / /wptagent
-
 RUN curl -sL https://deb.nodesource.com/setup_16.x | bash -
-
-### UPDATE ###
 RUN apt update 
 
 ### INSTALL APT-GET LIBS ###
@@ -39,33 +31,40 @@ RUN ln -fs /usr/share/zoneinfo/$TIMEZONE /etc/localtime && DEBIAN_FRONTEND=nonin
     python3-dev libavutil-dev libmp3lame-dev libx264-dev yasm autoconf automake build-essential libass-dev libfreetype6-dev libtheora-dev \
     libtool libvorbis-dev pkg-config texi2html libtext-unidecode-perl python3-numpy python3-scipy perl \
     adb ethtool nodejs cmake git-core libsdl2-dev libva-dev libvdpau-dev libxcb1-dev libxcb-shm0-dev libxcb-xfixes0-dev texinfo wget \
-    ttf-mscorefonts-installer fonts-noto fonts-roboto fonts-open-sans ffmpeg npm sudo curl
+    ttf-mscorefonts-installer fonts-noto fonts-roboto fonts-open-sans ffmpeg npm sudo curl xvfb
 
 ### UPDATE FONT CACHE ###
 RUN fc-cache -f -v
 
-### UPGRADING PIP AND INSTALLING REQUIRED PACKAGES ###
-RUN python3 -m pip install --upgrade --user pip && \
-    python3 -m pip install --user -r /wptagent/.github/workflows/requirements.txt 
-
 ### INSTALLING LIGHTHOUSE FROM NPM ###
 RUN npm install -g lighthouse
 
 ### INSTALLING CHROME BROWSER ###
-RUN curl -o google-chrome-stable_current_amd64.deb  https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb && \
-    apt install -y /google-chrome-stable_current_amd64.deb && rm /google-chrome-stable_current_amd64.deb
+RUN curl -o /tmp/google-chrome-stable_current_amd64.deb  https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb && \
+    apt install -y /tmp/google-chrome-stable_current_amd64.deb && rm /tmp/google-chrome-stable_current_amd64.deb
+
+### UPGRADING PIP AND INSTALLING REQUIRED PACKAGES ###
+COPY /.github/workflows/requirements.txt /tmp/agent_requirements.txt
+RUN python3 -m pip install --upgrade --user pip && \
+    python3 -m pip install --user -r /tmp/agent_requirements.txt && \
+    rm /tmp/agent_requirements.txt
 
+### COPYING ENTIRE DIR TO LOCAL DOCKER /wptagent ###
+# see .dockerignore for filterd out folders
+# source copy last so we don't need to rebuild all the other layers 
+COPY / /wptagent
 WORKDIR /wptagent
 
 ENTRYPOINT ["/bin/sh", "/wptagent/docker/linux-headless/entrypoint.sh"]
 
 ### DEBUG CONTAINER ###
 FROM production as debug
 
+### INSTALLING DEBUG DEPENDENCIES ###
 RUN pip install debugpy
 
+### COPY DEBUG AGENT AND MOVE REAL ONE ###
 RUN mv wptagent.py wptagent_starter.py
-
 COPY wptagent_debug.py wptagent.py
 
 ### SETTING PRODUCTION BUILD AS DEFAULT ###

README.md

@@ -141,37 +141,6 @@ The test result is written as JSON to `stdout`. If a server, location, and key a
 - `--testruns`: Number of runs to test. Defaults to 1.
 - `--testrv`: Include repeat view (defaults to only testing first view)
 
-### Running the container
-
-The `Dokerfile`` has multi-stage definition:
-* **production**: Default stage, produce a image without debug features;
-* **debug**: When running the produced image the wptagent script will wait for a debug to.attach
-
-arguments can be passed at build time:
-* **TIMEZONE**: to set the timezone inside the container
-* **
-
-To build the production container
-```sh
-docker build --tag wptagent .
-```
-To build the debug container
-```sh
-docker build --target debug --tag wptagent-debug .
-```
-
-The entrypoint is `docker\linux-headless\entrypoint.sh` that has some of the above parameters as default: `--xvfb`, `--dockerized`, `-vvvv`.
-Mandatory parameters are required via environment variables:
-* **SERVER_URL**: corresponding to `--server` parameter;
-* **LOCATION**: corresponding to `--location` parameter.
-
-Additional parameters can be passed. A typical run in debug mode looks like this
-
-```sh
-docker run --network="host" -e SERVER_URL=http://127.0.0.1:80/work/ -e LOCATION=Test wptagent-debug --key 123456789
-```
-
-where `-vvvv` and `--key` are optional parameters passed to the wptagent script.
 ## Supported features
 
 The following [Script Commands](https://docs.webpagetest.org/scripting/) are supported on Windows, Linux, Mac, and Android:

docs/docker.md

@@ -1,45 +1,78 @@
-# Linux Headless Agent
+# Docker Linux Headless Agent
 
-To run the agent, simply specify a few environment variables with docker:
+The `Dokerfile` has multi-stage definition:
+* **production**: Default stage, produce a image without debug features;
+* **debug**: When running the produced image the wptagent script will wait for a debug to.attach
+
+## Build the Image
 
-* `SERVER_URL`: will be passed as `--server` (note: it must end with '/work/')
-* `LOCATION`: will be passed as `--location`
-* `KEY`: will be passed as `--key`
-* `NAME`: will be passed as `--name` (optional)
-* `SHAPER`: will be passed as `--shaper` (optional)
-* `EXTRA_ARGS`: extra command-line options that will be passed through verbatim (optional)
+Arguments can be passed at build time:
+* **TIMEZONE**: to set the timezone inside the container
 
+To build the production container
+```bash
+docker build --tag wptagent .
+```
+To build the debug container
+```bash
+docker build --target debug --tag wptagent-debug .
+```
 ## Prerequisites to use traffic shaping in docker
 **Experimental**: Running the agent with traffic shaping is experimental. It might
 have influence on the host system network. Running multiple agents on the
 same host might result in incorrect traffic shaping.
 
 For traffic shaping to work correctly, you need to load the ifb module on the **host**:
-
+```bash
     sudo modprobe ifb numifbs=1
+```
 
 Also, the container needs `NET_ADMIN` capabilities, so run the container with 
 `--cap-add=NET_ADMIN`.
 
-To disable traffic-shaping, pass SHAPER="none".
+To disable traffic-shaping, pass environment variable at docker un `SHAPER="none"`.
 
-## Container Disk Space Fills Up Quickly
-
-If you see disk space within the container filling up rapidly and you notice
-core dump files in the /wptagent folder, try adding `--shm-size=1g` to your Docker run
-command. This can help resolve an issue with shared memory and headless Chrome in Docker.
+## Run the container
+To run the agent, simply specify a few environment variables with docker:
 
-## Example
+- `SERVER_URL`: will be passed as `--server` (note: it must end with '/work/')
+- `LOCATION`: will be passed as `--location`
+- `KEY`: will be passed as `--key`
+- `NAME`: will be passed as `--name` (optional)
+- `SHAPER`: will be passed as `--shaper` (optional)
+- `EXTRA_ARGS`: extra command-line options that will be passed through verbatim (optional)
 
-Build the image first (from project root), load ifb and start it the container:
+Build the image first (from project root), load ifb and start it the container.
 
-    sudo docker build --tag wptagent .
+A typical run :
+```bash
     sudo modprobe ifb numifbs=1
-    sudo docker run -d \
+    docker build --tag wptagent .
+    docker run -d \
       -e SERVER_URL="http://my-wpt-server.org/work/" \
       -e LOCATION="docker-location" \
       -e NAME="Docker Test" \
       --cap-add=NET_ADMIN \
       --init \
       wptagent
+```
+
+Additional parameters can be also passed as additional commands. 
+A typical run in debug mode, note that we need to expose the port as `50000`:
+```bash
+sudo modprobe ifb numifbs=1
+docker run -d \
+    -e SERVER_URL=http://127.0.0.1:80/work/ \
+    -e LOCATION=Test \
+    --init \
+    --cap-add=NET_ADMIN \
+    -p 50000:50000 \
+    wptagent-debug
+    --key 123456789
+```
+
+## Container Disk Space Fills Up Quickly
 
+If you see disk space within the container filling up rapidly and you notice
+core dump files in the /wptagent folder, try adding `--shm-size=1g` to your Docker run
+command. This can help resolve an issue with shared memory and headless Chrome in Docker.