2023-12-29 12:12:36 +00:00
|
|
|
# unlighthouse Docker Image
|
2023-12-21 11:03:21 +00:00
|
|
|
|
2023-12-29 12:12:36 +00:00
|
|
|
Image based on `node:20.10.0-bookworm` with `chromium` and `unlighthouse` preinstalled.
|
|
|
|
|
|
|
|
It can be used for benchmarking a given site with lighthouse and to generate corresponding reports with ease.
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
The unlighthouse cli can be used by running the command `unlighthouse` inside the container
|
|
|
|
|
|
|
|
```shell
|
|
|
|
unlighthouse-ci --site "https://preview.firq.dev/"
|
|
|
|
```
|
|
|
|
|
|
|
|
It is recommended to provide a `unlighthouse.config.ts` to reduce the amount of CLI arguments needed.
|
|
|
|
|
|
|
|
An example config can be found here:
|
|
|
|
|
|
|
|
```typescript
|
|
|
|
export default {
|
|
|
|
puppeteerOptions: {
|
|
|
|
args: ["--no-sandbox", "--disable-setuid-sandbox"],
|
|
|
|
},
|
|
|
|
ci: {
|
|
|
|
budget: 90,
|
|
|
|
buildStatic: true
|
|
|
|
},
|
|
|
|
outputPath: "unlighthouse-reports",
|
|
|
|
}
|
|
|
|
```
|