Skip to main content

Agent Installation

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

  1. Browse to https://YourKnocknoc.url/admin and login with the knocknoc-admin user.
  2. Click on Agents then Create Agent.
  3. Enter a sensible name e.g. [AgentServerHostname].
  4. Copy the token that is produced.
  5. Login to the server hosting the agent via the command line and become the root user.
  6. Run this command it will configure apt, setup secure repository access, and install knocknoc agent.
    curl -sSL | bash
  7. Accept the License Agreement.
  8. Enter the URL and Port of your Knocknoc server.
  9. Paste the agent token from earlier.
  10. Confirm if you have a valid SSL certificate on your Knocknoc server
  11. You can now start adding Backends and ACLs.

To get knocknoc-agent working through a web proxy, add the proxy environment variable to the systemd unit file.

  1. Edit the systemd unit file.
    vi /etc/systemd/system/knocknoc-agent.service
  2. Add this line under the [service] section
  3. Reload the systemctl daemon
    systemctl daemon-reload
  4. Restart knocknoc-agent 
    systemctl restart knocknoc-agent

Agent Requirements

The agent will attempt to connect to your Knocknoc server using https on port 443/TCP. This could be on the Internet or internally within your own network. The package installation will automatically prompt you for the server hostname. You can reconfigure this in the config file (typically /opt/knocknoc-agent/etc/knocknoc-agent.conf) or by running configure-knocknoc-agent.

The agent is currently supported on the following platforms:

  • Debian 11 (Buster)
  • Debian 12 (Bookworm)
  • Ubuntu 23.10 (Mantic)
  • Ubuntu 22.04 (Jammy)
  • Ubuntu 20.04 (Focal)
  • Red Hat EL7+
  • CentOS 7+
  • Other Red Hat derivatives like Rocky and Oracle Linux
  • Microsoft Windows
  • Debian ARM64 (e.g. Raspberry Pi)
  • Docker on amd64 Linux

We are in the process of working on support for:

  • MacOS
  • Docker on arm64 Linux

Let us know if you're looking to use a different platform!