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 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 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 https://packages.knocknoc.io/setup/setup_knocknoc_agent.sh | 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.

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

On the roadmap for the agent is MacOS support and Docker on arm. Keep in mind that for Knocknoc to manage ACLs on other devices, like firewalls, routers and even cloud platforms, the agent just needs to be able to reach those devices, it doesn't need to be installed on them.