-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
website/docs: endpoint devices #18634
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
👷 Deploy Preview for authentik-storybook processing.
|
✅ Deploy Preview for authentik-integrations ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
❌ 1 Tests Failed:
View the top 1 failed test(s) by shortest run time
To view more test analytics, go to the Test Analytics Dashboard |
|
authentik PR Installation instructions Instructions for docker-composeAdd the following block to your AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-6c5ec1fafe06b7b25fc2435b148a870cfc8fcf3e
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)sAfterwards, run the upgrade commands from the latest release notes. Instructions for KubernetesAdd the following block to your authentik:
outposts:
container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
global:
image:
repository: ghcr.io/goauthentik/dev-server
tag: gh-6c5ec1fafe06b7b25fc2435b148a870cfc8fcf3eAfterwards, run the upgrade commands from the latest release notes. |
|
|
||
| import DocCardList from "@theme/DocCardList"; | ||
|
|
||
| Device compliance lets authentik verify that a user's device meets security and configuration criteria, such as operating system version, disk encryption, antivirus status etc, before allowing access to resources. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
with fleet?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With or without fleet.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
so should be mentioned or made more clear imo
website/docs/endpoint-devices/device-compliance/device-reporting.md
Outdated
Show resolved
Hide resolved
website/docs/endpoint-devices/device-compliance/device-reporting.md
Outdated
Show resolved
Hide resolved
website/docs/endpoint-devices/device-compliance/device-reporting.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Dominic R <[email protected]> Signed-off-by: Dewi Roberts <[email protected]>
Co-authored-by: Dominic R <[email protected]> Signed-off-by: Dewi Roberts <[email protected]>
|
|
||
| The Endpoint stage fetches [device facts](../../../../endpoint-devices/device-compliance/device-reporting.md#device-facts) via a configured [connector](../../../../endpoint-devices/device-compliance/connectors.md) for use in the flow. These device facts can be used by other stages and policies to make device compliance decisions. | ||
|
|
||
| ### Connector |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mean, this page has no section why not just make it H2s?
|
|
||
| Select the [connector](../../../../endpoint-devices/device-compliance/connectors.md) that the Endpoint stage should use to obtain device information. | ||
|
|
||
| ### Mode |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And here
|
|
||
| ### Mode | ||
|
|
||
| Select whether an endpoint device is required for the stage to succeed or not. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Select whether an endpoint device is required for the stage to succeed or not. | |
| Select whether an endpoint device is required for the stage to succeed. |
website/docs/endpoint-devices/authentik-agent/agent-deployment/linux.md
Outdated
Show resolved
Hide resolved
website/docs/endpoint-devices/authentik-agent/agent-deployment/linux.md
Outdated
Show resolved
Hide resolved
| ak-sysd domains join <name_for_authentik_domain> -a <authentik_FQDN> | ||
| ``` | ||
|
|
||
| - `name_for_authentik_domain` is the name that will be used to identify the authentik deployment on the device. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same as other doc
| ``` | ||
|
|
||
| - `name_for_authentik_domain` is the name that will be used to identify the authentik deployment on the device. | ||
| - `authentik_FQDN` is the fully qualified domain name of the authentik deployment. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same as other doc
| Where `URL` is the FQDN of your authentik deployment and `ClientID` is the Client ID of the [`authentik-cli` provider](../configuration.md#create-an-application-and-provider-in-authentik-for-cli). | ||
|
|
||
| 3. Save the file as `authentik.reg` and ensure that **Save as type** is set to **All Files**. | ||
| 4. Locale the `authentik.reg` file in File Explorer, right-click it and select **Merge**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 4. Locale the `authentik.reg` file in File Explorer, right-click it and select **Merge**. | |
| 4. Locate the `authentik.reg` file in File Explorer, right-click it and select **Merge**. |
|
|
||
| You'll need to add a registry entry for WCP to work: | ||
|
|
||
| 1. On the Windows device, open the Notepad application |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 1. On the Windows device, open the Notepad application | |
| 1. On the Windows device, open the Notepad application. |
|
|
||
| The authentik Agent primarily outputs logs to Windows Event Viewer. | ||
|
|
||
| WCP logs to the `wcp.log` file in `C:\Program Files\Authentik Security Inc\wcp`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| WCP logs to the `wcp.log` file in `C:\Program Files\Authentik Security Inc\wcp`. | |
| WCP logs to the `wcp.log` located in `C:\Program Files\Authentik Security Inc\wcp`. |
dominic-r
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
14/31 files reviewed. time for lunch
website/docs/endpoint-devices/authentik-agent/authentik-cli.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| Establish an SSH connection with the target endpoint device. | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ``` | |
| ```bash |
| tags: [authentik Agent, connector, configure, configuration] | ||
| --- | ||
|
|
||
| To support the deployment of the authentik Agent on devices, you first need to configure your authentik deployment. This involves importing the [Device code flow](../../add-secure-apps/providers/oauth2/device_code.md), creating an OAuth application/provider pair, and creating a [Connector](../device-compliance/connectors.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To deploy the authentik agent, you must:
- import rhe oauth device code flow
- create an oauth application and provider for cli authentication
- create an authentik agent connector
^^ like this cause the block feels quite convoluted otherwise
|
|
||
| ## Configure SSH authentication on an endpoint device | ||
|
|
||
| If you want a Linux Endpoint Device to support accepting SSH connections using authentik credentials, you will need to install the `libpam-authentik` package in addition the authentik Agent. This is a PAM Module, which provides token-based and interactive authentication via authentik. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| If you want a Linux Endpoint Device to support accepting SSH connections using authentik credentials, you will need to install the `libpam-authentik` package in addition the authentik Agent. This is a PAM Module, which provides token-based and interactive authentication via authentik. | |
| If you want a Linux Endpoint Device to support accepting SSH connections using authentik credentials, you will need to install the `libpam-authentik` package in addition to the authentik Agent. This is a PAM Module, which provides token-based and interactive authentication via authentik. |
|
|
||
| ## Configure sudo authorization on an endpoint device | ||
|
|
||
| If you want a Linux Endpoint Device to support authorizing using authentik credentials, you will need to install the `libpam-authentik` package in addition the authentik Agent. This is a PAM Module, which provides token-based and interactive authentication via authentik. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| If you want a Linux Endpoint Device to support authorizing using authentik credentials, you will need to install the `libpam-authentik` package in addition the authentik Agent. This is a PAM Module, which provides token-based and interactive authentication via authentik. | |
| If you want a Linux Endpoint Device to support authorizing using authentik credentials, you will need to install the `libpam-authentik` package in addition to the authentik Agent. This is a PAM Module, which provides token-based and interactive authentication via authentik. |
| | Platform | Component | Description | Dependencies | | ||
| | ------------------------- | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | ||
| | **Linux, macOS, Windows** | `authentik-cli` | Provides commands for interacting with `authentik-agent`. | `authentik-agent` | | ||
| | **Linux, macOS, Windows** | `authentik-agent` | User service. | `authentik-sysd` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mabye we can add a few mroe words to describe what this is
| | ------------------------- | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | ||
| | **Linux, macOS, Windows** | `authentik-cli` | Provides commands for interacting with `authentik-agent`. | `authentik-agent` | | ||
| | **Linux, macOS, Windows** | `authentik-agent` | User service. | `authentik-sysd` | | ||
| | **Linux, macOS, Windows** | `authentik-sysd` | System service. | None | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same as. above
| - `sys.sock` for general communication | ||
| - `sys-ctrl.sock` for "domain" join | ||
|
|
||
| ## Important considerations |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this could just be a :::warning at the top of file or something
dominic-r
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Went and did other stuff for a bit, here's files 23/31
website/docs/endpoint-devices/authentik-agent/release-notes/index.mdx
Outdated
Show resolved
Hide resolved
website/docs/endpoint-devices/device-authentication/cli-app-authentication/aws.mdx
Outdated
Show resolved
Hide resolved
website/docs/endpoint-devices/device-authentication/cli-app-authentication/aws.mdx
Outdated
Show resolved
Hide resolved
website/docs/endpoint-devices/device-authentication/cli-app-authentication/aws.mdx
Outdated
Show resolved
Hide resolved
website/docs/endpoint-devices/device-authentication/cli-app-authentication/aws.mdx
Outdated
Show resolved
Hide resolved
| 1. Open a Terminal session and run the following command: | ||
|
|
||
| ``` | ||
| ak ssh <hostname> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ak ssh <hostname> | |
| ak ssh <hostname> |
no indent
|
|
||
| ``` | ||
| ak ssh <hostname> | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ``` |
| ak ssh <hostname> | ||
| ``` | ||
|
|
||
| 2. If not already authentiacted, you will be prompted for authentik credentials. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 2. If not already authentiacted, you will be prompted for authentik credentials. | |
| 2. If not already authenticated, you will be prompted for authentik credentials. |
|
|
||
| ## Configure SSH authentication on an endpoint device | ||
|
|
||
| If you want a Linux Endpoint Device to support accepting SSH connections using authentik credentials, you will need to install the `libpam-authentik` package in addition the authentik Agent. This is a PAM Module, which provides token-based and interactive authentication via authentik. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mabye we can link to a reference on PAM modules idk if we have any?
| Authentication is only possible if the Linux device is aware of the authentik user which is attempting to authenticate. This can be achieved in one of two ways: | ||
|
|
||
| 1. **Provision user accounts** - Create users on the Linux device with usernames that match authentik users that need to authenticate to the device. This can be done manually or via automation tools like Ansible. | ||
| 2. **`libnss-authentik`** - This is a package that can be installed on the Linux device. It is an NSS module that makes the Linux device aware of authentik users. Similar to adding a Linux device to an Active Directory or LDAP domain. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same with nss. mabye a little more than "Similar to" + Active directory uses LDAP so mabye we can scratch off AD and just mention LDAP
Co-authored-by: Dominic R <[email protected]> Signed-off-by: Dewi Roberts <[email protected]>
Co-authored-by: Dominic R <[email protected]> Signed-off-by: Dewi Roberts <[email protected]>
tanberry
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First batch, more to come, looks great overall thaks @dewi-tik !
|
|
||
| You can deploy the authentik agent on [Linux](./linux.md), [macOS](./macos.md), and [Windows](./windows.md) devices. | ||
|
|
||
| Documentation for large-scale deployments via [Mobile Device Management (MDM)](./mdm.mdx) tools is also available. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Documentation for large-scale deployments via [Mobile Device Management (MDM)](./mdm.mdx) tools is also available. | |
| Large-scale deployments via [Mobile Device Management (MDM)](./mdm.mdx) tools is also supported. |
|
|
||
| Documentation for large-scale deployments via [Mobile Device Management (MDM)](./mdm.mdx) tools is also available. | ||
|
|
||
| For more information, pick a topic below: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| For more information, pick a topic below: | |
| For more information, select a topic below: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
or "refer to a topic.." but "pick" feels too slangy, imo.
| tags: [authentik Agent, linux, deploy, packages] | ||
| --- | ||
|
|
||
| ## What can it do |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ## What can it do | |
| ## What the authentik agent does |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
or "What does the authentik agent do?"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm still torn about the capitalization of the word "agent". A parallel is the term "Endpoint stage"... in whihc we capitalize the proper name (Endpoint) but not the word "stage". I think the same applies here, just so happens that authentik is lower-case.
|
|
||
| ## What can it do | ||
|
|
||
| - Retrieves information about the host for use in authentik, see [Device Compliance](../../device-compliance/index.mdx). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - Retrieves information about the host for use in authentik, see [Device Compliance](../../device-compliance/index.mdx). | |
| - Retrieves information about the host (known as "device facts") for use by authentik; see [Device Compliance](../../device-compliance/index.mdx) for more information. |
Co-authored-by: Dominic R <[email protected]> Signed-off-by: Dewi Roberts <[email protected]>
Details
WIP - DRAFTY DRAFT