Skip to content

Update installation instructions to use rpm and deb package repositories #403

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

Merged
tashian merged 2 commits into from
Apr 8, 2025
Merged

Update installation instructions to use rpm and deb package repositories #403

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
651dce5
Update installation instructions to use rpm and deb package repositories
tashian Apr 8, 2025
750eeb6
More updated install instructions
tashian Apr 8, 2025
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
82 changes: 49 additions & 33 deletions step-ca/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
updated_at: April 08, 2025
title: Install step-ca
html_title: Installing open source step-ca
description: Learn how to install step-ca
Expand All @@ -22,12 +23,13 @@ Learn how to to install the `step-ca` binary on your local machine.
- [Winget Package](#winget-package)
- [Scoop Package](#scoop-package)
- [Linux Packages](#linux-packages-amd64)
- [Debian/Ubuntu](#debianubuntu)
- [Debian/Ubuntu](#debian-ubuntu)
- [RHEL/Fedora](#rhel-fedora)
- [Arch Linux](#arch-linux)
- [RedHat](#redhat)
- [Alpine Linux](#alpine-linux)
- [NixOS](#nixos)
- [FreeBSD](#freebsd)
- [Wolfi](#wolfi)
- [Linux Binaries](#linux-binaries)
- [Binary Signature Verification](#binary-signature-verification)
- [Kubernetes](#kubernetes)
Expand Down Expand Up @@ -83,24 +85,46 @@ To uninstall, run `scoop uninstall`, then remove the configuration directory `$H

#### Debian/Ubuntu

To install `step`, download and install the Debian package for your platform from our [latest release](https://github.com/smallstep/cli/releases/latest):

```shell
wget https://dl.smallstep.com/cli/docs-ca-install/latest/step-cli_amd64.deb
sudo dpkg -i step-cli_amd64.deb
```
To add Smallstep as a source and install the `step-cli` and `step-ca` packages on Debian or Ubuntu distributions, run the following as `root`:

To install `step-ca`, download and install the Debian package for your platform from our [latest release](https://github.com/smallstep/certificates/releases/latest):
```
apt-get update && apt-get install -y --no-install-recommends curl vim gpg ca-certificates
curl -fsSL https://packages.smallstep.com/keys/apt/repo-signing-key.gpg -o /etc/apt/trusted.gpg.d/smallstep.asc && \
echo 'deb [signed-by=/etc/apt/trusted.gpg.d/smallstep.asc] https://packages.smallstep.com/stable/debian debs main' \
| tee /etc/apt/sources.list.d/smallstep.list
apt-get update && apt-get -y install step-cli step-ca
```

```shell
wget https://dl.smallstep.com/certificates/docs-ca-install/latest/step-ca_amd64.deb
sudo dpkg -i step-ca_amd64.deb
```
Alternatively, to manually install a `.deb` for `step-cli` and `step-ca`, find the packages you need for your platform on our GitHub release pages for [`smallstep/cli`](https://github.com/smallstep/cli/releases/latest) (`step-cli`) and [`smallstep/certificates`](https://github.com/smallstep/certificates/releases/latest) (`step-ca`).

To configure `step-ca` as a daemon, see our [systemd configuration guide][systemd-setup].

To uninstall, run `dpkg -r step-cli step-ca`, then remove the configuration directory `$HOME/.step`.

#### RHEL/Fedora

To add Smallstep as a source and install the `step-cli` and `step-ca` packages on RHEL or Fedora distributions, run the following as `root`:

```
cat <<EOT > /etc/yum.repos.d/smallstep.repo
[smallstep]
name=Smallstep
baseurl=https://packages.smallstep.com/stable/fedora/
enabled=1
repo_gpgcheck=0
gpgcheck=1
gpgkey=https://packages.smallstep.com/keys/smallstep-0x889B19391F774443.gpg
EOT
dnf makecache && dnf install -y step-cli step-ca
```


Alternatively, to manually install an `.rpm` for `step-cli` and `step-ca`, find the packages you need for your platform on our GitHub release pages for [`smallstep/cli`](https://github.com/smallstep/cli/releases/latest) (`step-cli`) and [`smallstep/certificates`](https://github.com/smallstep/certificates/releases/latest) (`step-ca`).

To configure `step-ca` as a daemon, see our [systemd configuration guide][systemd-setup].

To uninstall, run `dnf remove step-cli step-ca`, then remove the configuration directory `$HOME/.step`.

#### Arch Linux

These packages are maintained by trusted Arch Linux community members.
Expand All @@ -119,26 +143,6 @@ To uninstall, run `pacman -R step-ca step-cli`, then remove the configuration di

Big shout out to the maintainers of these packages! We appreciate you.

#### RedHat

To install `step`, download and install the RPM package for your platform from our [latest release](https://github.com/smallstep/cli/releases/latest):

```shell
wget https://dl.smallstep.com/cli/docs-ca-install/latest/step-cli_amd64.rpm
sudo rpm -i step-cli_amd64.rpm
```

To install `step-ca`, download and install the RPM package for your platform from our [latest release](https://github.com/smallstep/certificates/releases/latest):

```shell
wget https://dl.smallstep.com/certificates/docs-ca-install/latest/step-ca_amd64.rpm
sudo rpm -i step-ca_amd64.rpm
```

To configure `step-ca` as a daemon, see our [systemd configuration guide][systemd-setup].

To uninstall, run `dnf remove step-cli step-ca`, then remove the configuration directory `$HOME/.step`.

#### Alpine Linux

There are community-maintained Alpine Linux Packages for `step` and `step-ca`.
Expand Down Expand Up @@ -173,6 +177,18 @@ To install both packages in a FreeBSD jail, follow the steps in this [installati

Big shout out to the maintainers of these packages! We appreciate you.

#### Wolfi

[Wolfi](https://wolfi.dev) has a maintained `step-ca` package.

Use apk to install `step-ca`:

```
apk add step-ca
```

To uninstall, run `apk del step-ca` and remove the `$HOME/.step` configuration directory.

### Linux Binaries

We distribute pre-compiled binaries for amd64, arm64, armv6, armv7, mips, mips64, ppc64le, and 386.
Expand Down
76 changes: 46 additions & 30 deletions step-cli/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
updated_at: April 08, 2025
title: Install step
html_title: Installing open source step command
description: Learn how to install the step command
Expand All @@ -21,13 +22,13 @@ It's trivial to install the `step` binary on your local machine.

- [macOS](#macos)
- [Linux Packages](#linux-packages-amd64)
- [Debian](#debian-ubuntu)
- [Debian/Ubuntu](#debian-ubuntu)
- [RHEL/Fedora](#rhel-fedora)
- [Arch Linux](#arch-linux)
- [RedHat](#redhat)
- [Alpine Linux](#alpine-linux)
- [Wolfi](#wolfi)
- [NixOS](#nixos)
- [FreeBSD](#freebsd)
- [Wolfi](#wolfi)
- [Linux Binaries](#linux-binaries)
- [Signature Verification](#binary-signature-verification)
- [Windows](#windows)
Expand All @@ -46,15 +47,41 @@ To uninstall, run `brew uninstall step` and remove the `$HOME/.step` configurati

#### Debian/Ubuntu

Download and install the Debian package from our [latest release](https://github.com/smallstep/cli/releases/latest):
To add Smallstep as a source and install the `step-cli` package on Debian or Ubuntu distributions, run the following as `root`:

```shell
wget https://dl.smallstep.com/cli/docs-cli-install/latest/step-cli_amd64.deb
sudo dpkg -i step-cli_amd64.deb
```
apt-get update && apt-get install -y --no-install-recommends curl vim gpg ca-certificates
curl -fsSL https://packages.smallstep.com/keys/apt/repo-signing-key.gpg -o /etc/apt/trusted.gpg.d/smallstep.asc && \
echo 'deb [signed-by=/etc/apt/trusted.gpg.d/smallstep.asc] https://packages.smallstep.com/stable/debian debs main' \
| tee /etc/apt/sources.list.d/smallstep.list
apt-get update && apt-get -y install step-cli
```

Alternatively, to manually install a `.deb` for `step-cli`, find the package you need for your platform on our GitHub release pages for [`smallstep/cli`](https://github.com/smallstep/cli/releases/latest) (`step-cli`).

To uninstall, run `sudo dpkg -r step-cli` and remove the `$HOME/.step` configuration directory.

#### RHEL/Fedora

To add Smallstep as a source and install the `step-cli` packages on RHEL or Fedora distributions, run the following as `root`:

```
cat <<EOT > /etc/yum.repos.d/smallstep.repo
[smallstep]
name=Smallstep
baseurl=https://packages.smallstep.com/stable/fedora/
enabled=1
repo_gpgcheck=0
gpgcheck=1
gpgkey=https://packages.smallstep.com/keys/smallstep-0x889B19391F774443.gpg
EOT
dnf makecache && dnf install -y step-cli step-ca
```

Alternatively, to manually install an `.rpm` for `step-cli`, find the packages you need for your platform on our GitHub release pages for [`smallstep/cli`](https://github.com/smallstep/cli/releases/latest) (`step-cli`).

To uninstall, run `sudo dnf remove step-cli` and remove the `$HOME/.step` configuration directory.

#### Arch Linux

There is a community-maintained [`step-cli` package](https://archlinux.org/packages/extra/x86_64/step-cli/).
Expand All @@ -76,29 +103,6 @@ To uninstall, run `sudo pacman -R step-cli` and remove the `$HOME/.step` configu

Big shout out to the maintainers of these packages! We appreciate you.

#### RedHat

Download and install the RPM package from our [latest release](https://github.com/smallstep/cli/releases/latest):

```shell
wget https://dl.smallstep.com/cli/docs-cli-install/latest/step-cli_amd64.rpm
sudo rpm -i step-cli_amd64.rpm
```

To uninstall, run `sudo dnf remove step-cli` and remove the `$HOME/.step` configuration directory.

#### Wolfi

[Wolfi](https://wolfi.dev) has a maintained `step` package.

Use apk to install `step`:

```
apk add step
```

To uninstall, run `apk del step` and remove the `$HOME/.step` configuration directory.

#### Alpine Linux

There is a community-maintained [`step-cli` package](https://pkgs.alpinelinux.org/packages?name=step-cli&branch=edge&repo=&arch=&maintainer=) for Alpine Linux.
Expand All @@ -121,6 +125,18 @@ Install the [`step-cli`](https://search.nixos.org/packages?channel=20.09&show=st

Install the [`step-cli`](https://www.freshports.org/security/step-cli/) package on FreeBSD.

#### Wolfi

[Wolfi](https://wolfi.dev) has a maintained `step` package.

Use apk to install `step`:

```
apk add step
```

To uninstall, run `apk del step` and remove the `$HOME/.step` configuration directory.

### Linux Binaries

We have 386, amd64, arm64, armv7, mips, and mips64 releases available to download from our [latest
Expand Down