Use Reg-suit’s reg-publish-s3-plugin to publish and fetch visual-regression snapshot images from an Amazon S3 bucket. Create a bucket reachable by your CI identity, install and prepare the plugin, set its required bucketName, then decide deliberately whether reports should be private or public. The plugin README documents a public-read ACL default, so verify ACL behavior and access controls before publishing artifacts.
What the S3 plugin stores
reg-publish-s3-plugin is Reg-suit’s S3 publisher. It publishes and fetches snapshot images used in visual-regression reports; it is not a general-purpose browser screenshot capture tool. The plugin requires an S3 bucket accessible from the environment running Reg-suit, commonly CI. See the Reg-suit S3 plugin README for its current configuration and permission details.
As an Amazon Associate I earn from qualifying purchases.
The README on the repository’s master branch is mutable, and plugin defaults may differ by installed version. Check the package documentation for the version in your project before relying on specific defaults or IAM actions.
Do these 3 things before closing this tab:
1Repair Windows errors before they cause bigger problems2Fix the driver behind crashes, sound loss and screen glitches3Clear out junk files and repair common Windows errorsSet up the bucket and plugin
- Create or select an S3 bucket. Ensure the CI environment can authenticate to AWS and is authorized to access the intended bucket. Avoid embedding long-lived credentials in repository files; use the credential or role mechanism already approved for your CI environment.
- Install the publisher. The README shows
npm i reg-publish-s3-plugin -D. Confirm that command and package version against your project’s package manager and the plugin documentation. - Prepare Reg-suit for the S3 publisher. The README shows
reg-suit prepare -p publish-s3. Run it in the project where Reg-suit is configured. - Set the required bucket name. Configure
bucketNameto the S3 bucket that will hold the snapshot artifacts. - Choose the report path and access model. Set
pathPrefixif you want artifacts organized under a prefix. Decide who should be able to view reports before choosing ACL or policy settings. - Run a publish-and-fetch check in CI. Confirm that the workflow can publish and retrieve the artifacts it needs, then test report access as an intended viewer and as someone without authorization.
The exact configuration-file location and syntax depend on the Reg-suit setup and installed plugin version; use that version’s README rather than copying configuration from another release.
#1 Best Overall
Configuration options to review
| Option | Purpose and decision |
|---|---|
bucketName |
Required. Names the S3 bucket for snapshot images. |
pathPrefix |
Optional key prefix for organizing report artifacts within the bucket. |
customDomain |
Optional host for report URLs. Use only when the domain is configured to serve the bucket as intended. |
acl and enableACL |
ACL-related settings. The README describes public-read as the default ACL and enableACL as defaulting to true. Verify the behavior for your plugin version and bucket configuration; do not interpret the default as a recommendation to make reports public. |
sse |
Optional server-side encryption setting documented by the plugin. |
sseKMSKeyId |
Optional KMS key ID used with the documented KMS encryption setting. The CI role, bucket policy, and KMS key policy must all allow the required operations. |
sdkOptions |
Optional AWS SDK configuration. Consult the installed version’s documentation for supported values. |
Choose private or public report access deliberately
A visual-diff report can expose page content, internal URLs, or other information captured in snapshots. Decide who needs access before selecting how the artifacts are served. The plugin README’s documented public-read ACL default deserves particular attention: a public URL may be viewable by anyone who obtains it, depending on the surrounding configuration.
AWS says S3 resources are private by default and documents policies as a way to grant access to intended identities. Review AWS’s guidance on S3 access policy language and blocking public access. Bucket ownership and access-control configuration can affect ACL use, so check the current behavior of the target bucket as well as the plugin.
- For private reports, use authenticated AWS access or a controlled report-serving arrangement, and avoid broad public principals.
- For intentionally public reports, confirm that the snapshot contents are suitable for public release and that the chosen bucket and ACL configuration actually supports the intended access.
- For KMS encryption, validate permissions across the CI role, bucket, and KMS key policies before depending on it in a live workflow.
Grant CI only the permissions the workflow needs
The plugin README lists these actions under its IAM role policy: s3:DeleteObject, s3:GetObject, s3:GetObjectAcl, s3:PutObject, s3:PutObjectAcl, and s3:ListBucket. Treat this as the plugin’s documented action list, not a universal minimum for every configuration. Validate it against your installed plugin version, bucket ownership and ACL settings, and encryption choices.
The Tool Desk
Outbyte Driver Updater FREEFix the driver behind crashes, sound loss and screen glitchesFind Drivers →Outbyte PC Repair FREERepair Windows errors before they cause bigger problemsFix Now →Scope access to the intended bucket and, where practical, the relevant object prefix. Avoid granting broad access merely to make a failed CI publish pass; identify which operation failed and add only the authorization that operation requires.
Rank #3
- Low Cost Professional Grade Network Attached Storage - Optimized to organize, store, share, and back up your important and everyday files.
- Purpose-Built for Data Protection – Secure NAS with 256-bit drive encryption, a closed system, and flexible replication and backup features to keep your data safe.
- Fast Data Transfers – Native 2.5GbE port for high speed file transfers with no cable upgrade needed.
- Reliable Storage with Effortless Setup – Hard drives included and RAID pre-configured for hassle-free, out-of-the-box protection, and can be changed to other RAID modes to best suit your needs.
- Cloud Integration – Sync with Amazon S3, Dropbox, Azure and OneDrive to create a hybrid cloud for extra data security, cost savings, and flexible scalability.
Troubleshoot common failures
- CI cannot find or access the bucket: Check that the configured
bucketNameis correct, the job is using the expected AWS identity, and the bucket policy and identity permissions allow the operation. - Publishing fails on an object operation: Compare the denied action with the plugin README’s action list and your installed version’s requirements. Check bucket and prefix scope rather than granting access across all buckets.
- ACL operations fail: Review the bucket’s ownership and ACL configuration, and confirm the plugin’s
enableACLandaclsettings. The documented default is not guaranteed to fit every bucket. - KMS-encrypted writes or reads fail: Check the selected
sseandsseKMSKeyIdvalues and ensure the CI role, bucket policy, and KMS key policy allow the required use of that key. - Report URLs do not resolve under a custom host: Confirm that
customDomainmatches a domain actually configured to serve the bucket and that the report path corresponds to the selected prefix. - Artifacts appear in an unexpected location: Check
pathPrefixand the bucket selected by the active CI configuration; confirm the URL or object key generated by the plugin version in use. - Reports are exposed more broadly than intended: Recheck ACLs, bucket policies, public-access settings, and custom-host access controls. Remove unintended public permissions and review whether already-published artifacts need to be restricted or removed.
Or skip the browser setup
If you also need to create website screenshots directly rather than store Reg-suit snapshots, ScreenshotNeo is a screenshot API and MCP server. One GET request returns an image or PDF; its clean-shot flow accepts consent banners and removes supported consent platforms, newsletter popups, and chat widgets before capture. Bot checks, blank pages, and failed loads are not billed, and its MCP server gives AI agents screenshot tools. The free plan includes 1,000 shots per month without a card; paid plans start at $5 for 3,000.
cURL example, adapted to capture a target page:
curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://stripe.com -o shot.webpSee the ScreenshotNeo API documentation for request options and setup. Sign up free for 1,000 screenshots a month with no card.
Quick Recap
Best Value
Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.
