Set up Snaglist on your own server

For site owners who want nothing loaded from anyone else, and reports from anyone, with or without a GitHub account. At the end, your server hosts snaglist.js and takes reports, and files them as GitHub issues with a key that never reaches the browser. It takes about 45 minutes.

Before you begin

A server that serves your site, and somewhere to run a small piece of server code, such as a Cloudflare Worker or your own app's server.
A GitHub repository for the reports, and permission to make a token for it.

The steps at a glance

Host the file on your server
Add it to your pages
Mark private parts of your pages
Set up the server that takes reports
Point Snaglist at your server
Make a test report
Guard against spam

flowchart TD
  accTitle: The steps at a glance
  accDescr: The steps in order: host the file on your server; add it to your pages; mark private parts of your pages; set up the server that takes reports; point Snaglist at your server; make a test report; guard against spam.
  A[Host snaglist.js] --> B[Add the script tag]
  B --> C[Mark private parts]
  C --> D[Set up the report server]
  D --> E[Point Snaglist at it]
  E --> F[Make a test report]
  F --> G[Guard against spam]

Step 1: host the file on your server

Download a fixed version and serve it with your other files. Follow Host Snaglist on your own server. You know it worked when its address opens the file in a browser.

Step 2: add it to your pages

Add the script tag and a Snaglist.start() call: Add Snaglist to a website.

Step 3: mark private parts of your pages

Follow Keep personal details out of reports. This matters more when anyone can report.

Step 4: set up the server that takes reports

Run the example worker, or your own code, with a token that can only write issues in one repository. Follow the example in Send reports to your own server.

Step 5: point Snaglist at your server

Set send: { endpoint: { url: "https://reports.example/" } }. You can keep github as well, for people who would rather post from their own account.

Step 6: make a test report

Report something and select Send. You know it worked when Snaglist says "Report sent. Thank you." and the issue appears in GitHub with its labels. If not, read If a report does not send.

Step 7: guard against spam

Add a rate limit on your report server, or start Snaglist only for signed-in users or in test builds: Activate or deactivate Snaglist for everyone.

What next

Update Snaglist when a new version comes out.
Triage reports on GitHub