Skip to content
TLSCheck

Getting Started

TLSCheck

Section titled “TLSCheck”

TLSCheck is a Chromium/Chrome extension that surfaces TLS certificate state for the active tab, with a self-hostable API backend including OCSP/CRL revocation checks.

Installation

Section titled “Installation”

Chrome Extension

Section titled “Chrome Extension”
  1. Build the extension:
Terminal window
npm install
node scripts/build.js chrome
  1. Load the extension in Chrome:
  • Open chrome://extensions
  • Enable “Developer mode”
  • Click “Load unpacked”
  • Select dist/chrome

API Service

Section titled “API Service”

The extension comes with a free public API pre-configured: https://free.tlscheck.net

You can also run your own API instance via Docker or directly from source.

Run with Podman

Section titled “Run with Podman”
Terminal window
podman run --rm --read-only --tmpfs /tmp -p 3000:3000 tlscheck/api

Run from Source

Section titled “Run from Source”
Terminal window
npm install
npm run build:api
npm run start:api

The API will be available at http://localhost:3000

Project Layout

Section titled “Project Layout”
  • Source code: src/
  • Chrome manifest: platforms/chrome/manifest.json
  • Build output: dist/chrome
  • API code: api/

Documentation

Section titled “Documentation”