linuxserver/ci pulls statistics

[][linuxserverurl]

Contact information:-

| Type | Address/Details |

| Discord | Discord | | Forum | [Linuserver.io forum][forumurl] |

[linuxserver/ci][huburl]

What is this?

This container is an automated testing tool for Docker images. It's designed to perform a series of checks to ensure a container is healthy and functional before it's released. Here's what it does:

1. Spins up the container: It runs the target Docker image with a specified tag. 2. Checks for successful startup: It tails the container's logs, waiting for the [services.d] done. message, which confirms the init system has finished and the services are running. 3. Generates an SBOM: It uses syft to create a Software Bill of Materials, providing a complete list of all packages inside the image. 4. Tests the Web UI (optional): If the container runs a web service, it attempts to connect to the UI and take a screenshot to verify it's accessible and renders correctly. 5. Generates a report: It gathers all the results—container logs, build info, SBOM, screenshots, and test statuses—into a comprehensive HTML report. 6. Uploads the report (CI only): In a CI environment, it uploads the final report to an S3 bucket for review.

Developer Mode (Local Testing)

For local development and debugging, you can use CI_LOCAL_MODE. This mode runs all the tests but skips the S3 upload, saving the report directly to a local folder. It's the easiest way to test a container without needing cloud credentials.

Example Run Command

Run this command from your terminal. It will test the linuxserver/plex:latest image and place the report in an output directory in your current folder.

Viewing the Report

Once the script finishes, you can view the detailed HTML report with this command:

Note: You can use any modern web browser (Firefox, Chrome, etc.).

Key Local Variables

| Variable | Description | Example |

| CI_LOCAL_MODE | Required. Enables local mode, disables S3 uploads. | true | | IMAGE | Required. The full name of the image to test. | linuxserver/plex | | TAGS | Required. The tag(s) to test. Use \| to separate multiple tags. | latest | | BASE | Required. The base distribution of the image. | ubuntu or alpine | | WEB_SCREENSHOT | Set to true to enable screenshot testing for web UIs. | true | | PORT | The internal port the web UI listens on. | 32400 | | SSL | Set to true if the web UI uses https://. | false | | WEB_PATH | The specific path to the web UI landing page. | /web/index.html | | WEB_AUTH | Credentials for basic auth, format user:password. Leave empty for none. | "" | | WEB_SCREENSHOT_DELAY | Seconds to wait after the page loads before taking the screenshot. | 20 |

Advanced Usage (CI Environment)

This container is not meant for public consumption as it is hard coded to LinuxServer endpoints for storage of resulting reports.

The following shows the full list of environment variables used when the container is run by our CI system, [linuxserver/pipeline-triggers][pipelineurl].

The following line is only in this repo for loop testing:

• { date: "01.01.50:", desc: "I am the release message for this internal repo." }

Description from the Docker Hub listing.