Install in 5 minutes

You need Docker (Desktop on macOS and Windows, Engine with the compose plugin on Linux) and Chrome, or another Chromium browser of version 142 or newer (Edge, Brave, Arc). Firefox is not supported yet.

1. Run one commandCopy Anchor Link

curl -fsSL https://raw.githubusercontent.com/FindMalek/skiffr/main/install.sh | sh

The script makes a skiffr/ folder, downloads the compose file of the latest release (checked against that release's SHA256SUMS), generates every secret into skiffr/.env (permissions 600), pulls the images, starts everything, waits until it is healthy and prints (all later commands run inside that folder, so cd skiffr first):

  dashboard   http://localhost:3002
  api         http://localhost:3001   (the url to paste in the extension)
  site        http://localhost:3000
  docs        http://localhost:3003

  sign in     admin@skiffr.local
  password    <20 random characters>   (shown once, it is also in skiffr/.env)

The admin is created and reset to the .env values on every api start, so a password you change in the dashboard is reverted by the next restart or update. Change it in .env.

The download of the compose file is checked against the SHA256SUMS of the same release. That catches a truncated or corrupted download, not a compromised repository or release: the sums and the files come from the same place, and install.sh itself comes from the main branch. If that matters to you, read the script first (it is one file), and pin a release you have looked at with --version v0.1.0. Signed attestations of the release files are planned.

It asks nothing. Run it again at any time: .env and the data are never overwritten, only missing keys are added.

No curl, or you want the source? Clone and run the same thing:

git clone https://github.com/FindMalek/skiffr
cd skiffr
./scripts/setup.sh           # pulls the released images
./scripts/setup.sh --build   # builds them from this checkout instead (several minutes)

A build from source has no extension zip at /downloads: build the extension yourself with pnpm install && pnpm --filter extension build and load apps/extension/.output/chrome-mv3.

OptionsCopy Anchor Link

Pass them after sh -s -- when piping: curl ... | sh -s -- --port 4000.

On localhost, why it works without a domainCopy Anchor Link

Every app is published on 127.0.0.1 on its own port, and the dashboard proxies the sign-in to the api, so the session cookie is first-party on localhost. The extension calls the api directly at http://localhost:3001 with its token. Nothing is exposed to your network: the ports are bound to the loopback address, and the database has no published port at all. To reach it from another device use --domain, or set SKIFFR_BIND=0.0.0.0 and the public urls in .env yourself.

Your own domainCopy Anchor Link

Point four DNS records at the server (skiffr.example.com, dashboard., api. and docs. under it), open ports 80 and 443, then:

curl -fsSL https://raw.githubusercontent.com/FindMalek/skiffr/main/install.sh | sh -s -- --domain skiffr.example.com

A bundled Caddy gets the certificates from Let's Encrypt and proxies each name to its app. The extension then uses https://api.skiffr.example.com.

2. Load the extension (60 seconds)Copy Anchor Link

Chrome does not install an extension from a file on its own, so this step is by hand. Your own server serves the extension that matches its version.

1. Download http://localhost:3001/downloads/skiffr-extension.zip and unzip it into a folder you will keep. Chrome does not install zips, it loads an unzipped folder.
2. Open chrome://extensions (Edge edge://extensions, Brave brave://extensions, Arc arc://extensions) and turn on Developer mode at the top right.
3. Click Load unpacked and pick the unzipped folder.
4. Pin the skiffr icon from the puzzle menu in the toolbar.

Do not delete the folder: Chrome reads the extension from it.

3. Connect it and applyCopy Anchor Link

1. Open the dashboard, sign in with the printed email and password and fill in your profile. A fill without a profile stops with a message.
2. Open Extension in the dashboard and create a token. Copy it.
3. Right-click the skiffr icon and choose Options (or chrome://extensions, Details, Extension options). Set the api url to the one the installer printed, paste the token and press Test connection.
4. Open a job application form. A toast asks "Autofill this application?", press Yes. Ctrl+Shift+F (Cmd+Shift+F on macOS) fills the current page without the toast.

Review what was filled: fields the model is unsure about are outlined in amber. Skiffr never submits a form, never clicks submit, next or apply buttons and never touches password or hidden inputs, you press the button yourself. What it does on a page is in the extension.

First run checklist:

• the dashboard loads and you are signed in
• your profile is saved
• a token is created and Test connection says connected
• one real application form is filled and submitted by you

AI keys are optional. Without them the profile, saved answers, the queue and saved-answer fills all work. To let the model map fields your saved answers do not cover, put GROQ_API_KEY in skiffr/.env (get one) and run docker compose up -d again. OPENAI_API_KEY adds similar-question suggestions. See environment and privacy for what is sent.

TroubleshootingCopy Anchor Link

Update, back up, removeCopy Anchor Link

Run these inside the skiffr/ folder, cd skiffr first (from a clone: ./scripts/skiffr).

To remove skiffr completely: docker compose down -v, then delete the folder. Restoring a backup, automatic updates and the rules for rollbacks are in deploy. Releases, versions and the extension zip come from releasing. A Chrome Web Store listing, which would update the extension by itself, is tracked in issue 26 and is not available yet.