Getting started

Install

Download and run PrintLink on Windows / macOS / Linux, confirm the service, change the port and the start-at-login behaviour. The web SDK needs no installation.

Last updated

There is only one component to install: the desktop Agent. The web SDK is served by PrintLink itself — no browser plug-in, ever.

1. Download and install

Open the download section; it recommends a package for the current device and lists every platform (each with a SHA-256).

PlatformPackageNotes
Windows 10 / 11 (x64)PrintLink_<version>_x64-setup.exeDouble-click to install
Windows (portable)PrintLink_<version>_x64-portable.exeRuns without installing
macOS 11+ (Apple silicon)PrintLink_<version>_aarch64.dmgDrag into Applications
Linux (Debian / Ubuntu)PrintLink_<version>_amd64.debsudo dpkg -i <package>
Linux (others)PrintLink_<version>_amd64.AppImagechmod +x and run; needs CUPS

Windows portable build

The portable build skips the installer's environment preparation, so the target machine needs Microsoft Edge WebView2 Runtime. Before replacing an installed build, quit PrintLink from the tray, then replace the executable keeping the same file name.

2. Confirm the service is running

After launching, a PrintLink icon appears in the tray (menu bar on macOS); click it to start or pause the service. To verify:

curl http://127.0.0.1:17888/healthz

A 200 means it is running. The console overview shows the WebSocket and SDK addresses, each with a copy button.

3. Change the port or listen scope (optional)

By default PrintLink listens on 127.0.0.1:17888 and accepts local connections only.

  • Port: console → Settings → Service port, with a conflict check. If you change it, replace 17888 in your pages too.
  • LAN or remote access: off by default and needs explicit configuration. Read deployment topology first — do not widen the scope just to save a step.

4. Start at login

On by default: PrintLink launches after you log in. You can turn it off in Settings → Interface; turning it off also removes the system entry, so nothing is left behind.

It is separate from "start the service": the first decides whether the operating system launches PrintLink, the second decides whether PrintLink starts its printing service. The two can be set independently.

5. Updates

PrintLink checks for updates over HTTPS and verifies the package signature, refusing untrusted sources. Use Check for updates in Settings or next to the version number. Enterprises can pin the channel with machine policy.

6. The web SDK needs no installation

One line in your page:

<script src="http://127.0.0.1:17888/sdk/printlink.js"></script>

Project-based apps can install the ESM build (with TypeScript types):

npm install @printlink/sdk

For offline intranets, Settings → Local SDK package exports a versioned .tgz (SHA-256 included).

Common installation problems

SymptomWhat to do
A page cannot reach PrintLinkCheck the tray says running; curl http://127.0.0.1:17888/healthz; check the port was not changed
Port already in usePick another port in Settings, or stop the process holding 17888 (PORT_UNAVAILABLE)
macOS refuses to open the appSystem Settings → Privacy & Security → Open Anyway
Linux lists no printersCheck CUPS is running (systemctl status cups) and your user can access queues
WebView2 missing on WindowsUse the installer (it prepares the runtime) or install WebView2 Runtime

More in the FAQ and troubleshooting.

On this page