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.

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

docs: adjust language on releases #778

Merged
merged 5 commits into from
Feb 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@
# NOTE: By default, the following MyST extensions are enabled:
# substitution, deflist, linkify

# myst_enable_extensions = set()
myst_enable_extensions = set({"colon_fence"})


# Auto-generate header anchors
Expand Down
46 changes: 36 additions & 10 deletions docs/howto/install-authd.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,60 @@
# Installation

This project consists of two components:
* authd: The authentication daemon responsible for managing access to the authentication mechanism.
* an identity broker: The services that handle the interface with an identity provider. There can be several identity brokers installed and enabled on the system.
* **authd**: The authentication daemon responsible for managing access to the authentication mechanism.
* **identity broker**: The services that handle the interface with an identity provider. There can be several identity brokers installed and enabled on the system.

authd is delivered as a Debian package.
authd is delivered as a Debian package for Ubuntu Desktop and Ubuntu Server.

## System requirements

* Distribution: Ubuntu Desktop 24.04 LTS or Ubuntu Server 24.04 LTS
* Architectures: amd64, arm64

## Install authd

```{note}
While this project is in active development, a version for Ubuntu 24.04 is available from the [authd testing PPA](https://launchpad.net/~ubuntu-enterprise-desktop/+archive/ubuntu/authd). <br />
You can install authd from the [stable PPA](https://launchpad.net/~ubuntu-enterprise-desktop/+archive/ubuntu/authd).
edibotopic marked this conversation as resolved.
Show resolved Hide resolved

You can add this PPA to your system's software sources with the following commands:
To add this PPA to your system's software sources, run the following commands:

```shell
sudo add-apt-repository ppa:ubuntu-enterprise-desktop/authd
sudo apt update
```

Install the following Debian packages (note that `gnome-shell` and `yaru-theme*` are only required for desktop integration, server installations may ignore them):
```{note}
The stable PPA release of authd can be used today as an authentication service.
This project is under active development and the release of authd to the
official archive is planned for Ubuntu 26.04 LTS.
```

Then install authd and any additional Debian packages needed for your system of
choice:

:::::{tab-set}
:sync-group: system

::::{tab-item} Ubuntu Desktop
:sync: desktop

```shell
sudo apt install authd gnome-shell yaru-theme-gnome-shell
```
::::

::::{tab-item} Ubuntu Server
:sync: server

```shell
sudo apt install authd
```
::::
:::::

## Install brokers

The brokers are provided as Snap packages and available from the Snap Store.
The brokers are provided as Snap packages and are available from the Snap
Store.

### MS Entra ID broker

Expand All @@ -40,7 +64,8 @@ To install the MS Entra ID broker, run the following command:
sudo snap install authd-msentraid
```

At this stage, you have installed the main service and an identity broker to authenticate against Microsoft Entra ID.
At this stage, you have installed the main service and an identity broker to
authenticate against Microsoft Entra ID.

### Google IAM broker

Expand All @@ -50,4 +75,5 @@ To install the Google IAM broker, run the following command:
sudo snap install authd-google
```

At this stage, you have installed the main service and an identity broker to authenticate against Google IAM.
At this stage, you have installed the main service and an identity broker to
authenticate against Google IAM.
Loading