-
-
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?
Changes from 31 commits
767251d
9aae663
0af80b0
f882e7e
851428d
8914a44
1fda132
8aaad46
56abb58
a809faa
3a6b578
d837365
b265f85
6b54784
d737f31
1c6a43c
d6950f5
6c1bcb2
533c0e7
250c9b0
2303dd0
0adfe1d
20671ef
c8ce5fb
27a3945
7ba8799
8e65955
6c5ec1f
81f6780
53d1776
e0123a1
c9e1137
8ebb4f5
38b8f25
d0d96af
fcb87d6
d6ffae5
c4ecd15
7d3a154
dac2974
6e4cd1f
eebfd45
699f1c4
807de9c
81cc182
bc90f47
6a0340a
dfc2c85
8f8ed87
a9bb042
a405e42
ed62da6
eea81f3
56aec96
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,15 @@ | ||||||
| --- | ||||||
| title: Endpoint stage | ||||||
| --- | ||||||
|
|
||||||
| This stage integrates with [Endpoint Device](../../../../endpoint-devices/index.mdx) functionality, allowing you to verify whether a device executing a flow is registered with authentik. | ||||||
|
|
||||||
| 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. | ||||||
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
| ### Connector | ||||||
|
||||||
|
|
||||||
| Select the [connector](../../../../endpoint-devices/device-compliance/connectors.md) that the Endpoint stage should use to obtain device information. | ||||||
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
| ### Mode | ||||||
|
||||||
|
|
||||||
| 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 or not. | |
| Select whether an endpoint device is required for the stage to succeed. |
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,14 @@ | ||||||
| --- | ||||||
| title: Deployment | ||||||
| sidebar_label: Deployment | ||||||
| --- | ||||||
|
|
||||||
| import DocCardList from "@theme/DocCardList"; | ||||||
|
|
||||||
| You can deploy the authentik Agent on [Linux](./linux.md), [macOS](./macos.md), and [Windows](./windows.md) devices. | ||||||
dewi-tik marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| Documentation for large-scale deployments via [Mobile Device Management (MDM)](./mdm.mdx) tools is also available. | ||||||
|
||||||
| 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. |
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Outdated
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.
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,84 @@ | ||||||
| --- | ||||||
| title: Deploy authentik Agent on Linux | ||||||
dewi-tik marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| sidebar_label: Linux | ||||||
| tags: [authentik Agent, linux, deploy, packages] | ||||||
| --- | ||||||
|
|
||||||
| ## What can it do | ||||||
|
||||||
| ## 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.
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Outdated
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. |
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
dewi-tik marked this conversation as resolved.
Show resolved
Hide resolved
dewi-tik marked this conversation as resolved.
Show resolved
Hide resolved
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Outdated
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.
| - `authentik_FQDN` is the fully qualified domain name of the authentik deployment. | |
| - `https://authentik.company` is the fully qualified domain name of the authentik deployment. |
Outdated
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.
| All authentik Agent related logs output to the Linux system logging service, `syslog`. | |
| authentik Agent logs are available via the system journal (`systemd`) or `syslog`, depending on the distribution. |
systemd is the default for logs pretty much everywhere i think?
depending on the distribution <--- can be removed, tbd idk
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,72 @@ | ||||||
| --- | ||||||
| title: Deploy authentik Agent on macOS | ||||||
| sidebar_label: macOS | ||||||
| tags: [authentik Agent, mac, macos, deploy] | ||||||
| --- | ||||||
|
|
||||||
| ## What it can do | ||||||
|
|
||||||
| - Retrieves information about the host for use in authentik, see [Device Compliance](../../device-compliance/index.mdx). | ||||||
| - Authorize Sudo elevation, see [Sudo authorization](../../device-authentication/sudo-authorization.md). (TODO - needs testing) | ||||||
| - SSH to Linux hosts using authentik credentials, see [SSH authentication](../../device-authentication/ssh-authentication.mdx). | ||||||
dewi-tik marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| - Authenticate CLI applications using authentik credentials, see [CLI application authentication](../../device-authentication/cli-app-authentication/index.mdx). | ||||||
|
|
||||||
| ## Prerequisites | ||||||
|
|
||||||
| You must [configure your authentik deployment](../configuration.md) to support the authentik Agent. | ||||||
|
|
||||||
| ## Install the authentik Agent | ||||||
|
|
||||||
| (TODO - guide via UI) | ||||||
|
|
||||||
| Follow these steps to install the authentik Agent on your macOS device: | ||||||
|
|
||||||
| 1. Open the [authentik Platform Packages](https://pkg.goauthentik.io) page. | ||||||
| 2. Under **Desktop packages** click on **macOS** to download the macOS package. | ||||||
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| 3. Once the download is complete, attempt to install the package. Default Apple security settings should block the install. | ||||||
| - This can be avoided by Option + Right Clicking the package and clicking **Open**. | ||||||
| - Alternatively use the following command to remove the package from quarantine: `xattr -r -d com.apple.quarantine "$HOME/Downloads/authentik agent installer.pkg"` | ||||||
| 4. If prompted, enter your login password and click OK. You should now be able to install the package. | ||||||
| 5. Continue through the installation wizard steps. | ||||||
| 6. Confirm that the authentik Agent is installed by opening a Terminal window and entering the following command: `ak` | ||||||
dewi-tik marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| You should see a response that starts with: `authentik CLI v<version_number>` | ||||||
dewi-tik marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| ## Enable device authentication | ||||||
|
|
||||||
| To enable [device authentication features](../../device-authentication/index.mdx), you must connect the device to an authentik deployment. To do so, follow these steps: | ||||||
|
|
||||||
| 1. Open a Terminal session and run the following command: | ||||||
|
|
||||||
| ```sh | ||||||
| ak config setup --authentik-url <authentik_FQDN> | ||||||
|
||||||
| ``` | ||||||
|
|
||||||
| 2. A browser will open and direct you to the authentik login page. Once authenticated, the authentik Agent will be configured. | ||||||
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
| ## Enable device compliance | ||||||
|
|
||||||
| To enable [device compliance features](../../device-compliance/index.mdx), you must join the device to an authentik domain. This can be done via the CLI or by editing a configuration file. | ||||||
|
|
||||||
| ### CLI | ||||||
|
|
||||||
| 1. Open a Terminal session and run the following command: | ||||||
|
|
||||||
| ```sh | ||||||
| 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. | ||||||
|
||||||
| - `authentik_FQDN` is the fully qualified domain name of the authentik deployment. | ||||||
|
||||||
|
|
||||||
| 2. (TODO) | ||||||
|
|
||||||
| ### Configuration file | ||||||
|
|
||||||
| 1. Create the following file: `/etc/authentik/domains/ak.json` | ||||||
| 2. Paste the following values into the file: | ||||||
|
|
||||||
| (TODO) JSON codeblock | ||||||
|
|
||||||
| ## Logging | ||||||
|
|
||||||
| The authentik Agent uses macOS's native logging abilities. To retrieve the logs, open the Console application and then filter for the relevant authentik Agent component (for example, `==sysd`). | ||||||
|
||||||
| The authentik Agent uses macOS's native logging abilities. To retrieve the logs, open the Console application and then filter for the relevant authentik Agent component (for example, `==sysd`). | |
| The authentik Agent uses macOS's native logging abilities. To retrieve the logs, open the Console application and then filter for authentik-related processes such as `authentik-agent` or `authentik-sysd`. |
i think???
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| title: Deploy authentik Agent via MDM | ||
| sidebar_label: MDM | ||
| tags: [authentik Agent, mdm, fleet, deploy] | ||
| --- | ||
|
|
||
| authentik Agent can be deployed at scale to multiple devices via Mobile Device Management (MDM) tools. (TODO) | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| You must [configure your authentik deployment](../configuration.md) to support the authentik Agent. | ||
|
|
||
| ## Windows | ||
|
|
||
| (TODO) | ||
|
|
||
| ## Linux | ||
|
|
||
| (TODO) | ||
|
|
||
| ## macOS | ||
|
|
||
| (TODO) |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,110 @@ | ||||||
| --- | ||||||
| title: Deploy authentik Agent on Windows | ||||||
| sidebar_label: Windows | ||||||
| tags: [authentik Agent, windows] | ||||||
| --- | ||||||
|
|
||||||
| ## What can it do | ||||||
|
||||||
| ## What can it do | |
| ## What it can do |
Outdated
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.
| :::info Windows Versions | |
| :::warn Supported Windows Versions |
Outdated
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.
| The authentik Agent is currently only tested on Windows 11 and Windows Server 2022. | |
| The authentik Agent is currently only tested on Windows 11 and Windows Server 2022. Other versions may work but are untested. |
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
dewi-tik marked this conversation as resolved.
Show resolved
Hide resolved
Outdated
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 docs
dewi-tik marked this conversation as resolved.
Show resolved
Hide resolved
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Outdated
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
Outdated
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
Outdated
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. |
dewi-tik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Outdated
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**. |
dewi-tik marked this conversation as resolved.
Show resolved
Hide resolved
Outdated
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`. |
Uh oh!
There was an error while loading. Please reload this page.