Merge pull request #359 from smallstep/carl/agent-docs

A few fixes from Josh
smallstep · Nov 6, 2024 · a3520e7 · a3520e7
2 parents f5647f2 + 853545d
commit a3520e7
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 14 deletions.
diff --git a/platform/smallstep-agent.mdx b/platform/smallstep-agent.mdx
@@ -114,7 +114,7 @@ curl -sL https://packages.smallstep.com/scripts/smallstep-agent-install.sh | bas
     ```
     
 
-## Debian
+### Debian
 
 1. In the Terminal, install dependencies:
     
@@ -150,7 +150,7 @@ curl -sL https://packages.smallstep.com/scripts/smallstep-agent-install.sh | bas
     ```
     
 
-## Ubuntu
+### Ubuntu
 
 1. In the Terminal, install dependencies:
     
@@ -189,7 +189,14 @@ curl -sL https://packages.smallstep.com/scripts/smallstep-agent-install.sh | bas
 
 ## Configure the agent
 
-Update `/etc/step-agent/agent.yaml` config file, with your Smallstep team ID and Smallstep Agent CA fingerprint.
+To configure the agent and register your Linux device with Smallstep, run:
+
+```jsx
+step-agent-plugin register
+```
+
+Alternatively, you can configure the agent manually.
+Simply update `/etc/step-agent/agent.yaml` config file, with your Smallstep team ID and Smallstep Agent CA fingerprint.
 
 ```jsx
 team: "yourteamname"
@@ -202,13 +209,6 @@ fingerprint: "40523785c1d1d11EXAMPLE017b660d52a5fa5f2cb94cf0e1a9e9209dbea0826"
     - Select the Smallstep Agents authority
     - Use the sha256 Root fingerprint displayed on this page
 
-## Register your device
-
-To register your Linux endpoint with Smallstep, run:
-
-```jsx
-step-agent-plugin register
-```
 
 ## Start the Smallstep agent
 

diff --git a/platform/smallstep-api.mdx b/platform/smallstep-api.mdx
@@ -108,8 +108,6 @@ Use the `data` field to store any relevant instance metadata, such as:
 - an instance’s region, name, or role(s)
 - DNS names (these can be mapped to a SANs using `deviceMetadataKeySANs`, above)
 
-#### 4. Install the Smallstep agent on each device.
+#### 4. Install the Smallstep app on each device.
 
-The agent will only need your `team` name and `fingerprint` for bootstrapping.
-
-See [Smallstep Agent Quickstart](https://smallstep.notion.site/Install-the-Smallstep-agent-on-a-Linux-server-11bd17a91249809f8127faffbb6b6263?pvs=4) for details.
+See [Smallstep App](./smallstep-app.mdx) for details.