Getting Started

The server

Cloud or self-hosted, you need a Knocknoc server, and once you have it up and running you will be able to login to the admin panel and start configuration.

For locally hosted servers, here is the install guide https://docs.knocknoc.io/books/admin-guide/page/server-installation

The agent

The agents perform the backend work of updating ACLs, so you need at least one, even if it's on the same machine as the server.

Here is the guide for installing the agent https://docs.knocknoc.io/books/admin-guide/page/agent-installation

Backends and ACLs

Backends and ACLs work hand in hand to provide a pathway for your fine tuned group access.

Here are the guides for the different backends https://docs.knocknoc.io/books/admin-guide/chapter/backends
And here are the guides for basic ACL configuration https://docs.knocknoc.io/books/admin-guide/chapter/acls

Groups and Authentication

Groups can be created either locally in the admin portal or via the SAML or LDAP authentication steps depending on your configuration. We recommend SAML where possible, as it is the most secure option for many people.

Here is where you will find the authentication guides https://docs.knocknoc.io/books/admin-guide/chapter/authentication
And this is the local group guide https://docs.knocknoc.io/books/admin-guide/page/groups

Test it out!

That first time you login and works feels like magic. We can't wait for you to enjoy using Knocknoc every day.

Roll it out to your users

Once everything is ready, you need to then need to demonstrate or document the steps for your users, and away you go.

Monitor and Manage

Knocknoc can stream metrics using GELF, and can supply regular exports of user activity.