# Key9

## Key9

- [Key9 Documentation Portal.](https://docs.k9.io/key9-identity/readme.md)
- [Installation & Setup](https://docs.k9.io/key9-identity/ssh/installation-and-setup.md)
- [MacOS Yubikey Smartcard/PIV instructions.](https://docs.k9.io/key9-identity/ssh/installation-and-setup/quickstart.md)
- [1. Installation of MacOS software](https://docs.k9.io/key9-identity/ssh/installation-and-setup/quickstart/1.-installation-of-macos-software.md)
- [2. Changing the Yubikey PIN.](https://docs.k9.io/key9-identity/ssh/installation-and-setup/quickstart/2.-changing-the-yubikey-pin..md)
- [3. Generating Keys and Certificates for the Yubikey](https://docs.k9.io/key9-identity/ssh/installation-and-setup/quickstart/3.-generating-keys-and-certificates-for-the-yubikey.md)
- [4. Enrolling the public key to Key9](https://docs.k9.io/key9-identity/ssh/installation-and-setup/quickstart/4.-enrolling-the-public-key-to-key9.md): \*\* NOTE: If your Yubikey is already enrolled with Key9, you can skip these steps!
- [5. Testing and configuring SSH](https://docs.k9.io/key9-identity/ssh/installation-and-setup/quickstart/5.-testing-and-configuring-ssh.md)
- [Windows Yubikey Smartcard/PIV instructions](https://docs.k9.io/key9-identity/ssh/installation-and-setup/windows-yubikey-smartcard-piv-instructions.md)
- [1. Installation of Windows software.](https://docs.k9.io/key9-identity/ssh/installation-and-setup/windows-yubikey-smartcard-piv-instructions/1.-installation-of-windows-software..md)
- [2. Getting the system ready for libykcs11.dll](https://docs.k9.io/key9-identity/ssh/installation-and-setup/windows-yubikey-smartcard-piv-instructions/2.-getting-the-system-ready-for-libykcs11.dll.md)
- [3. Adding libykcs11.dll to SSH configurations.](https://docs.k9.io/key9-identity/ssh/installation-and-setup/windows-yubikey-smartcard-piv-instructions/3.-adding-libykcs11.dll-to-ssh-configurations..md)
- [4. Generating Keys and Certificates for the Yubikey](https://docs.k9.io/key9-identity/ssh/installation-and-setup/windows-yubikey-smartcard-piv-instructions/4.-generating-keys-and-certificates-for-the-yubikey.md)
- [5. Enrolling the public key to Key9](https://docs.k9.io/key9-identity/ssh/installation-and-setup/windows-yubikey-smartcard-piv-instructions/5.-enrolling-the-public-key-to-key9.md): \*\* NOTE:  If your Yubikey is already enrolled with Key9,  you can skip these steps!
- [6.  Testing your SSH key.](https://docs.k9.io/key9-identity/ssh/installation-and-setup/windows-yubikey-smartcard-piv-instructions/6.-testing-your-ssh-key..md)
- [OpenSSH with Yubikey / FIDO2 protected keys](https://docs.k9.io/key9-identity/ssh/installation-and-setup/openssh-with-yubikey-fido2-protected-keys.md)
- [1. Prerequisites](https://docs.k9.io/key9-identity/ssh/installation-and-setup/openssh-with-yubikey-fido2-protected-keys/1.-prerequisites.md)
- [2. OpenSSH command for Yubkey FIDO2](https://docs.k9.io/key9-identity/ssh/installation-and-setup/openssh-with-yubikey-fido2-protected-keys/2.-openssh-command-for-yubkey-fido2.md): Unfortunately,  Windows 11 does not currently support FIDO2 enrollment.
- [3. Enrolling your public key to Key9](https://docs.k9.io/key9-identity/ssh/installation-and-setup/openssh-with-yubikey-fido2-protected-keys/3.-enrolling-your-public-key-to-key9.md)
- [4. Testing your SSH key](https://docs.k9.io/key9-identity/ssh/installation-and-setup/openssh-with-yubikey-fido2-protected-keys/4.-testing-your-ssh-key.md)
- [Setting a Yubikey PIN without Yubikey software.](https://docs.k9.io/key9-identity/ssh/installation-and-setup/setting-a-yubikey-pin-without-yubikey-software..md)
- [1.  Using Key9 "registration" to register a new Yubikey PIN.](https://docs.k9.io/key9-identity/ssh/installation-and-setup/setting-a-yubikey-pin-without-yubikey-software./1.-using-key9-registration-to-register-a-new-yubikey-pin..md)
- [2. Using "webauthn.io" to register a new Yubikey PIN.](https://docs.k9.io/key9-identity/ssh/installation-and-setup/setting-a-yubikey-pin-without-yubikey-software./2.-using-webauthn.io-to-register-a-new-yubikey-pin..md)
- [RSA Password Protected SSH Key](https://docs.k9.io/key9-identity/ssh/installation-and-setup/rsa-password-protected-ssh-key.md)
- [1. Key9 Settings to allow RSA](https://docs.k9.io/key9-identity/ssh/installation-and-setup/rsa-password-protected-ssh-key/1.-key9-settings-to-allow-rsa.md)
- [2. Generating RSA SSH Key](https://docs.k9.io/key9-identity/ssh/installation-and-setup/rsa-password-protected-ssh-key/2.-generating-rsa-ssh-key.md)
- [3. Enrolling your public key to Key9](https://docs.k9.io/key9-identity/ssh/installation-and-setup/rsa-password-protected-ssh-key/3.-enrolling-your-public-key-to-key9.md)
- [4. Testing your SSH key](https://docs.k9.io/key9-identity/ssh/installation-and-setup/rsa-password-protected-ssh-key/4.-testing-your-ssh-key.md)
- [Determine your Yubikey Type](https://docs.k9.io/key9-identity/ssh/installation-and-setup/determine-your-yubikey-type.md): Without loading the Yubikey Manager.
- [1. Linux "lsusb" command](https://docs.k9.io/key9-identity/ssh/installation-and-setup/determine-your-yubikey-type/1.-linux-lsusb-command.md)
- [2. MacOS "ioreg" command](https://docs.k9.io/key9-identity/ssh/installation-and-setup/determine-your-yubikey-type/2.-macos-ioreg-command.md)
- [3.  Windows 11](https://docs.k9.io/key9-identity/ssh/installation-and-setup/determine-your-yubikey-type/3.-windows-11.md)
- [Useful External Links](https://docs.k9.io/key9-identity/ssh/installation-and-setup/useful-external-links.md)
- [Windows Powershell with Yubikey/FIDO2-protected SSH keys](https://docs.k9.io/key9-identity/ssh/installation-and-setup/windows-powershell-with-yubikey-fido2-protected-ssh-keys.md)
- [1. Download OpenSSH for Windows.](https://docs.k9.io/key9-identity/ssh/installation-and-setup/windows-powershell-with-yubikey-fido2-protected-ssh-keys/1.-download-openssh-for-windows..md)
- [2. Setting up your SSH keys](https://docs.k9.io/key9-identity/ssh/installation-and-setup/windows-powershell-with-yubikey-fido2-protected-ssh-keys/2.-setting-up-your-ssh-keys.md)
- [3. Enrolling your public key to Key9](https://docs.k9.io/key9-identity/ssh/installation-and-setup/windows-powershell-with-yubikey-fido2-protected-ssh-keys/3.-enrolling-your-public-key-to-key9.md)
- [Technical Notes](https://docs.k9.io/key9-identity/ssh/installation-and-setup/technical-notes.md): "Here are the notes detailing issues and their respective fixes for Passkeys and SSH Keys."
- [Pop!\_OS - "agent refused operation"](https://docs.k9.io/key9-identity/ssh/installation-and-setup/technical-notes/pop-_os-agent-refused-operation.md): This fix may apply to other Linux distributions.
- [Key9 SSH for Debian 12 \[Bookworm\] Howto](https://docs.k9.io/key9-identity/ssh/installation-and-setup/key9-ssh-for-debian-12-bookworm-howto.md)
- [1. Installing GPG](https://docs.k9.io/key9-identity/ssh/installation-and-setup/key9-ssh-for-debian-12-bookworm-howto/1.-installing-gpg.md)
- [2. Configuring the Key9 Debian 12 Repo.](https://docs.k9.io/key9-identity/ssh/installation-and-setup/key9-ssh-for-debian-12-bookworm-howto/2.-configuring-the-key9-debian-12-repo..md)
- [3.  Configuring the Key9 SSH client](https://docs.k9.io/key9-identity/ssh/installation-and-setup/key9-ssh-for-debian-12-bookworm-howto/3.-configuring-the-key9-ssh-client.md): This page describes editing the /opt/k9/etc/k9.yaml
- [4.  Configuring Name Service Switch \[/etc/nsswitch.conf\]](https://docs.k9.io/key9-identity/ssh/installation-and-setup/key9-ssh-for-debian-12-bookworm-howto/4.-configuring-name-service-switch-etc-nsswitch.conf.md)
- [5. Configuring the OpenSSH server](https://docs.k9.io/key9-identity/ssh/installation-and-setup/key9-ssh-for-debian-12-bookworm-howto/5.-configuring-the-openssh-server.md)
- [6. Modifying "sudoers" \[optional\]](https://docs.k9.io/key9-identity/ssh/installation-and-setup/key9-ssh-for-debian-12-bookworm-howto/6.-modifying-sudoers-optional.md)
- [7. Configuring "k9-tail" for logs \[optional\]](https://docs.k9.io/key9-identity/ssh/installation-and-setup/key9-ssh-for-debian-12-bookworm-howto/7.-configuring-k9-tail-for-logs-optional.md)
- [8. Automatic home directory creation \[optional\]](https://docs.k9.io/key9-identity/ssh/installation-and-setup/key9-ssh-for-debian-12-bookworm-howto/8.-automatic-home-directory-creation-optional.md)
- [Marketplace Applications](https://docs.k9.io/key9-identity/web/marketplace.md): Easy Application creation.
- [Amazon Web Services](https://docs.k9.io/key9-identity/web/marketplace/amazon-web-services.md): Configuring Key9 Identity SAML SSO with AWS
- [Atlassian Jira](https://docs.k9.io/key9-identity/web/marketplace/atlassian-jira.md): Configuring Key9 Identity SAML SSO with Atlassian Jira
- [Cyera](https://docs.k9.io/key9-identity/web/marketplace/cyera.md): Configuring Key9 Identity SAML SSO with Cyera
- [DigitalOcean](https://docs.k9.io/key9-identity/web/marketplace/digitalocean.md): Configuring Key9 Identity OpenID with GitBook
- [GitBook](https://docs.k9.io/key9-identity/web/marketplace/gitbook.md): Configuring Key9 Identity SAML SSO with GitBook
- [Google Workspace](https://docs.k9.io/key9-identity/web/marketplace/google-workspace.md): Configuring Key9 Identity SAML SSO with Google Workspace
- [KnowBe4](https://docs.k9.io/key9-identity/web/marketplace/knowbe4.md): Configuring Key9 Identity SAML SSO with KnowBe4
- [LibreNMS](https://docs.k9.io/key9-identity/web/marketplace/librenms.md): Configuring Key9 Identity SAML SSO with LiberNMS
- [NetBox](https://docs.k9.io/key9-identity/web/marketplace/netbox.md): Configuring Key9 Identity SAML SSO with Netbox
- [SentinalOne](https://docs.k9.io/key9-identity/web/marketplace/sentinalone.md): Configuring Key9 Identity SAML SSO with SentinalOne
- [Wiz](https://docs.k9.io/key9-identity/web/marketplace/wiz.md): Configuring Key9 Identity SAML SSO with Wiz

## JSONAir

- [1. What is JSONAir](https://docs.k9.io/key9-identity/jsonair/1-what-is-jsonair.md): A cloud based, simple to use,  centralized configurations storage system.
- [1.1 Licensing](https://docs.k9.io/key9-identity/jsonair/1-what-is-jsonair/1.1-licensing.md): MIT License.
- [2. Installation](https://docs.k9.io/key9-identity/jsonair/2-install.md)
- [2.2 Dependancies](https://docs.k9.io/key9-identity/jsonair/2-install/2.2-dependancies.md): What you need to run JSONAir.
- [2.3 Compiling JSONAir](https://docs.k9.io/key9-identity/jsonair/2-install/2.3-compiling-jsonair.md): How to build JSONAir from source.
- [2.4 Database Setup](https://docs.k9.io/key9-identity/jsonair/2-install/2.4-database-setup.md): How to create and configure the JSONAir database.
- [2.5 Configuring and Running JSONAir](https://docs.k9.io/key9-identity/jsonair/2-install/2.5-configuration.md): How to configure and start the JSONAir server.
- [2.6 Configuring and Running the JSONAir Agent](https://docs.k9.io/key9-identity/jsonair/2-install/2.6-agent-configuration.md): How to configure and run the JSONAir agent.
- [2.7 Encrypting Configuration Data](https://docs.k9.io/key9-identity/jsonair/2-install/2.7-encrypting-config-data.md): How to encrypt and decrypt configuration data for storage in JSONAir.
- [2.8 Admin Web Interface](https://docs.k9.io/key9-identity/jsonair/2-install/2.8-admin-web-interface.md): How to configure and run the JSONAir admin web interface.
- [3. Using the API](https://docs.k9.io/key9-identity/jsonair/3-using-the-api.md): Overview of the JSONAir API.
- [3.1 Authentication](https://docs.k9.io/key9-identity/jsonair/3-using-the-api/3.1-authentication.md): How to authenticate with the JSONAir API.
- [3.2 Making API Requests](https://docs.k9.io/key9-identity/jsonair/3-using-the-api/3.2-make-api-requests.md): How to call the JSONAir API endpoints.
- [3.3 Golang Examples](https://docs.k9.io/key9-identity/jsonair/3-using-the-api/3.3-golang-examples.md): Go code examples for interacting with the JSONAir API.
- [3.4 Curl Examples](https://docs.k9.io/key9-identity/jsonair/3-using-the-api/3.4-curl-examples.md): curl examples for interacting with the JSONAir API.
- [3.5 Python Examples](https://docs.k9.io/key9-identity/jsonair/3-using-the-api/3.5-python-examples.md): Python code examples for interacting with the JSONAir API.

## Highvolt

- [Introduction](https://docs.k9.io/key9-identity/highvolt/getting-started/readme.md)
- [Architecture Overview](https://docs.k9.io/key9-identity/highvolt/getting-started/architecture.md)
- [Deployment Guide](https://docs.k9.io/key9-identity/highvolt/getting-started/deployment.md)
- [Overview](https://docs.k9.io/key9-identity/highvolt/highvolt-server/highvolt-server.md)
- [Configuration](https://docs.k9.io/key9-identity/highvolt/highvolt-server/configuration.md)
- [Authentication](https://docs.k9.io/key9-identity/highvolt/highvolt-server/authentication.md)
- [REST API Reference](https://docs.k9.io/key9-identity/highvolt/highvolt-server/api.md)
- [File Processing Pipeline](https://docs.k9.io/key9-identity/highvolt/highvolt-server/processors.md)
- [OpenSearch Integration](https://docs.k9.io/key9-identity/highvolt/highvolt-server/opensearch.md)
- [Voltage — Filesystem Scanner](https://docs.k9.io/key9-identity/highvolt/clients/voltage.md)
- [Suricata — Network Integration](https://docs.k9.io/key9-identity/highvolt/clients/suricata.md)
- [AWS S3 — Cloud Scanner (batch)](https://docs.k9.io/key9-identity/highvolt/clients/aws-s3.md)
- [AWS S3 Lambda — Real-Time Cloud Scanner](https://docs.k9.io/key9-identity/highvolt/clients/aws-s3-lambda.md)

## Maxmind API Proxy

- [Introduction](https://docs.k9.io/key9-identity/maxmind-api-proxy/readme.md)
- [Installation](https://docs.k9.io/key9-identity/maxmind-api-proxy/getting-started/installation.md)
- [Quick Start](https://docs.k9.io/key9-identity/maxmind-api-proxy/getting-started/quick-start.md)
- [Configuration File Reference](https://docs.k9.io/key9-identity/maxmind-api-proxy/configuration/configuration.md)
- [TLS / HTTPS Setup](https://docs.k9.io/key9-identity/maxmind-api-proxy/configuration/tls.md)
- [Run Modes](https://docs.k9.io/key9-identity/maxmind-api-proxy/configuration/run-modes.md)
- [Authentication](https://docs.k9.io/key9-identity/maxmind-api-proxy/api-reference/authentication.md)
- [IP Lookup Endpoint](https://docs.k9.io/key9-identity/maxmind-api-proxy/api-reference/lookup-endpoint.md)
- [Response Format](https://docs.k9.io/key9-identity/maxmind-api-proxy/api-reference/response-format.md)
- [How Caching Works](https://docs.k9.io/key9-identity/maxmind-api-proxy/caching/overview.md)
- [Running as a Service](https://docs.k9.io/key9-identity/maxmind-api-proxy/deployment/service.md)

## k9-ssh

- [Introduction](https://docs.k9.io/key9-identity/k9-ssh/readme.md)
- [Installation](https://docs.k9.io/key9-identity/k9-ssh/installation.md)
- [Configuration](https://docs.k9.io/key9-identity/k9-ssh/configuration.md)
- [SSH Integration](https://docs.k9.io/key9-identity/k9-ssh/ssh-integration.md)
- [Using k9-proxy](https://docs.k9.io/key9-identity/k9-ssh/k9-proxy.md)
- [Building from Source](https://docs.k9.io/key9-identity/k9-ssh/building.md)
- [Security](https://docs.k9.io/key9-identity/k9-ssh/security.md)
- [Troubleshooting](https://docs.k9.io/key9-identity/k9-ssh/troubleshooting.md)

## k9-tail

- [Overview](https://docs.k9.io/key9-identity/k9-tail/readme.md)
- [Installation](https://docs.k9.io/key9-identity/k9-tail/installation.md)
- [Configuration](https://docs.k9.io/key9-identity/k9-tail/configuration.md)
- [Usage](https://docs.k9.io/key9-identity/k9-tail/usage.md)
- [Building from Source](https://docs.k9.io/key9-identity/k9-tail/building.md)
- [Running as a Service](https://docs.k9.io/key9-identity/k9-tail/systemd.md)