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.
- Browse to https://YourKnocknoc.url/admin and login with the knocknoc-admin user.
- Click on Agents
andthen CreateAgent.Agent. - Enter a sensible name
ege.g. [AgentServerHostname]. - Copy the token that is produced.
- Login to the server hosting the agent via the command line and become the root user.
- 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
- Accept the License Agreement.
- Enter the URL and Port of your Knocknoc server.
- Paste the
AgentagentTokentoken from earlier. - Confirm if you have a valid SSL certificate on your Knocknoc server
- You can now start adding Backends and ACLs.
To get knocknoc-agent working through a web proxy; you canproxy, add the proxy environment variable to the systemd unit file.
- Edit the systemd unit file.
vi /etc/systemd/system/knocknoc-agent.service
- Add this line under the [service] section
Environment="HTTPS_PROXY=http://proxyIPaddress:proxyport"
- Reload the systemctl daemon
systemctl daemon-reload
- Restart knocknoc-agent
systemctl restart knocknoc-agent
For other systems, download links are in the Knocknoc Licensing Portal.
Agent Requirements
The agent will prompt youattempt to connect to theyour knocknocKnocknoc server componentusing duringhttps install,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 configurereconfigure itthis later within the config file (typically /opt/knocknoc-agent/etc/knocknoc-agent.conf
) or --configureby command.running This requires access to the knocknoc server hostname on port 443/TCP, using HTTPS (Secure Websockets)configure-knocknoc-agent
. 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,11Buster(Buster) - Debian
12,12Bookworm(Bookworm) - Ubuntu 23.10 (Mantic)
- Ubuntu 22.
04,04Jammy(Jammy) - Ubuntu 20.
04,04Focal(Focal) RedhatRedEl7+Hat EL7+CentosCentOS 7+- Other
redhatRedderitives,Hat derivatives likeRocky,Rocky and Oracle Linuxetc - Microsoft Windows
- Debian ARM64 (
ege.g.raspberryRaspberrypi)Pi) - Docker on amd64
linuxLinux
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!