Skip to content
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.

Sign up for GitHub

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

Clarify distinction between app and agent #360

Merged
merged 2 commits into from
Nov 11, 2024
Merged

Clarify distinction between app and agent #360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
396a7ad
Clarify distinction between app and agent
tashian Nov 7, 2024
5934a9f
Add link to point to smallstep agent
Linda-Ikechukwu Nov 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"path": "/platform/smallstep-app.mdx"
},
{
"title": "Smallstep Agent",
"title": "Smallstep Agent for Linux",
"path": "/platform/smallstep-agent.mdx"
}
]
Expand Down
8 changes: 5 additions & 3 deletions platform/smallstep-agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
---
title: Smallstep Agent
title: Smallstep Agent for Linux
html_title: Install the Smallstep Agent on a Linux endpoint
description: The Smallstep agent is used across security, IT, and DevOps teams to enable end-to-end network encryption, privileged access management, passwordless authentication, and much more.
---
The Smallstep Agent for Linux is a background component of the [Smallstep Desktop App](./smallstep-app.mdx).
Choose one or the other depending on your deployment needs.

While macOS and Windows can manage certificates and authentication settings via Mobile Device Management (MDM), Linux does not include automated remote management facilities. The Smallstep Agent brings vital certificate management features to your Linux users and endpoints. It is the [Smallstep App](./smallstep-app.mdx), without any GUI. It can be installed independently on any Linux device running systemd.
# Background

Linux users should install either the Smallstep Agent or the Smallstep App—not both.
While macOS and Windows can manage certificates and authentication settings via Mobile Device Management (MDM), Linux does not include automated remote management facilities. The Smallstep Agent brings vital certificate management features to your Linux users and endpoints. It can be installed independently on any Linux device running systemd.

In this document, we will install, configure, and start the Smallstep Agent on a Linux device running systemd. We also show how to use the agent’s built-in PKCS#11 (smart card) service. With the PKCS#11 service, you can access Smallstep certificates and keys from applications that support PKCS#11.

Expand Down
13 changes: 9 additions & 4 deletions platform/smallstep-app.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,19 @@ description: This document specifies app download links, system requirements, ru
---
Smallstep ensures that access to financial data, code repositories, PII, and other sensitive resources is only possible from trusted, company-managed devices.

The Smallstep desktop app is central to that process. It offers a uniform experience for device identity across macOS, Windows, and Linux, and is the foundation for Smallstep's high-assurance device identity attestation workflow, automating the issuance of certificates to devices and configuring the components that depend on these certificates.
The Smallstep desktop app is central to that process. It offers a uniform experience for device identity across macOS, Windows, and Linux, and is the foundation for Smallstep's high-assurance device identity attestation workflow, automating the issuance of certificates to devices and configuring the components that depend on these certificates. P.S: The Smallstep app operates differently for Linux. For Linux specific instructions, see [Smallstep Agent for Linux](https://smallstep.com/docs/platform/smallstep-agent).

Here's all the necessary info you need to install and use the app effectively and consciously:
Here's all the necessary info you need to install and use the Smallstep app effectively and consciously.

## Download

<Alert severity="info">
The Smallstep App includes the <a href="smallstep-agent.mdx">Smallstep Agent</a>,
which runs in the background.
</Alert>

Installers for macOS, Windows and Linux can be also be downloaded from [GitHub releases](https://github.com/smallstep/smallstep-desktop/releases). Releases are signed with, and can be verified, by cosign.

| Platform | Release |
|:--|:--|
| macOS | <a href='https://packages.smallstep.com/stable/darwin/Smallstep.dmg'>Latest Version</a> |
Expand All @@ -19,8 +26,6 @@ Here's all the necessary info you need to install and use the app effectively an
| Linux (.rpm) | <a href='https://packages.smallstep.com/stable/rpm/smallstep-desktop.rpm'>Latest Version</a> |
| Windows | <a href='https://packages.smallstep.com/stable/windows/Smallstep.exe'>Latest Version</a> |

Installers for macOS, Windows and Linux can be also be downloaded from [GitHub releases](https://github.com/smallstep/smallstep-desktop/releases). Releases are signed with, and can be verified, by cosign.

## System Requirements

### Windows
Expand Down