Skip to main content

Agent Installation

Quick Start

For the admin who know what they need, and needneeds a fast way to get it, you can use this command to setup and install knocknoc-agent very quickly.

The
  1. Browse to https://YourKnocknoc.url/admin and login with the knocknoc-admin user.
  2. Click on Agents and Create Agent.
  3. Enter a sensible name eg [AgentServerHostname].
  4. Copy the token that is produced.
  5. Login to the server hosting the agent works onvia the followingcommand platforms:

    • Debian 11, Busterline and Debianbecome 12,the Bookwormroot user.
    • Ubuntu 22.04, Jammy and Ubuntu 20.04, Focal
    • Redhat El7+
    • Centos 7+
    • Other redhat deritives, like Rocky, Oracle Linux etc
    • Microsoft Windows
    • Debian ARM64 (eg raspberry pi)
    • Docker on amd64 linux

    Simply runRun this command as a root user on your Debian system, and it will configure apt, setup secure repository access, and install knocknoc server.

    agent.
    curl -sSL https://packages.knocknoc.io/setup/setup_knocknoc_agent.sh | bash

  6. Accept

    Notethe -License Agreement.

  7. Enter the URL and Port of your Knocknoc server.
  8. Paste the Agent Token from earlier.
  9. Confirm if you needhave a repositoryvalid usernameSSL certificate on your Knocknoc server
  10. You can now start adding Backends and passwordACLs.
    11. to install knocknoc-agent. To get these, please login to the Knocknoc Licensing Portal. The script asks you for the repository username and password straight after agreeing to the license agreement, so please have this handy before you run the above command.

For other systems, download links are in the Knocknoc Licensing Portal.

Agent Requirements

The agent will prompt you to connect to the knocknoc server component during install, or you can configure it later with the config file or --configure command. This requires access to the knocknoc server hostname on port 443/TCP, using HTTPS (Secure Websockets). Often the knocknoc server is on the internet somewhere, and the agent connects out to it to receives commands.

The agent is currently supported on the following platforms:

  • Debian 11, Buster and Debian 12, Bookworm
  • Ubuntu 22.04, Jammy and Ubuntu 20.04, Focal
  • Redhat El7+
  • Centos 7+
  • Other redhat deritives, like Rocky, Oracle Linux etc
  • Microsoft Windows
  • Debian ARM64 (eg raspberry pi)
  • Docker on amd64 linux

Back to top