From a57520bf4b5bbdb850ecac3cf139f6367f8d5896 Mon Sep 17 00:00:00 2001 From: Michael Engel Date: Wed, 7 Aug 2024 17:40:12 +0200 Subject: [PATCH] Updated readthedocs section for installing BlueChi on Debian Signed-off-by: Michael Engel --- README.developer.md | 2 + doc/docs/getting_started/index.md | 16 -------- doc/docs/getting_started/installation.md | 45 ++++++++++++++++++++++ doc/docs/man/bluechi-agent-selinux.md | 2 +- doc/docs/man/bluechi-controller-selinux.md | 2 +- doc/mkdocs.yml | 2 +- 6 files changed, 50 insertions(+), 19 deletions(-) delete mode 100644 doc/docs/getting_started/index.md create mode 100644 doc/docs/getting_started/installation.md diff --git a/README.developer.md b/README.developer.md index 47da3dcb24..a908892516 100644 --- a/README.developer.md +++ b/README.developer.md @@ -22,6 +22,8 @@ - [Documentation](#documentation) - [Building MAN Pages](#building-man-pages) - [Packaging](#packaging) + - [RPM](#rpm) + - [DEB](#deb) ## Development diff --git a/doc/docs/getting_started/index.md b/doc/docs/getting_started/index.md deleted file mode 100644 index 34f2c2e8ab..0000000000 --- a/doc/docs/getting_started/index.md +++ /dev/null @@ -1,16 +0,0 @@ - -# Getting started with BlueChi - -On Fedora and CentOS-Stream systems (with [EPEL](https://docs.fedoraproject.org/en-US/epel/) repository enabled), all components of BlueChi can be directly installed via: - -```bash -dnf install bluechi \ - bluechi-agent \ - bluechi-ctl \ - bluechi-selinux \ - python3-bluechi -``` - -!!! Note - - The command above installs BlueChi's core components - `bluechi` and `bluechi-agent` - as well as additional packages. `bluechi-ctl` is a CLI tool to interact with BlueChi's public D-Bus API provided by `bluechi` (controller). An SELinux policy is installed via the `bluechi-selinux` package. The last one supplies the [typed python bindings](../api/client_generation.md#typed-python-client), which simplifies programming custom applications that interact with BlueChi's API. diff --git a/doc/docs/getting_started/installation.md b/doc/docs/getting_started/installation.md new file mode 100644 index 0000000000..93a3429b46 --- /dev/null +++ b/doc/docs/getting_started/installation.md @@ -0,0 +1,45 @@ + +# Installation + +The first step of getting started with BlueChi is the installation of it's components. + +## Fedora or CentOS + +On Fedora and CentOS-Stream systems (with [EPEL](https://docs.fedoraproject.org/en-US/epel/) repository enabled), all +components of BlueChi can be directly installed via: + +```bash +dnf install bluechi-controller \ + bluechi-agent \ + bluechi-ctl \ + bluechi-selinux \ + python3-bluechi +``` + +## Debian-based distributions + +On Debian systems, all components of BlueChi can be installed via: + +```bash +# Add BlueChi PPA +curl -s --compressed "https://raw.githubusercontent.com/eclipse-bluechi/bluechi-ppa/main/deb/KEY.gpg" | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/bluechi.gpg >/dev/null +curl -s --compressed -o /etc/apt/sources.list.d/bluechi.list "https://raw.githubusercontent.com/eclipse-bluechi/bluechi-ppa/main/deb/bluechi.list" +sudo apt update + +# Install BlueChi packages +sudo apt install bluechi-controller bluechi-agent bluechictl +``` + +The [typed python bindings](../api/client_generation.md#typed-python-client) are not provided as `.deb` package, but +can be installed from [pypi](https://pypi.org/project/bluechi/) via `pip`: + +```bash +pip install bluechi +``` + +## Building from source + +For building and packaging BlueChi from source, please refer to the respective section of the developer README on GitHub: + +- [Building](https://github.com/eclipse-bluechi/bluechi/blob/main/README.developer.md#build) +- [Packaging](https://github.com/eclipse-bluechi/bluechi/blob/main/README.developer.md#packaging) diff --git a/doc/docs/man/bluechi-agent-selinux.md b/doc/docs/man/bluechi-agent-selinux.md index 999de51ef1..ab97d76a37 100644 --- a/doc/docs/man/bluechi-agent-selinux.md +++ b/doc/docs/man/bluechi-agent-selinux.md @@ -1,2 +1,2 @@ ---8<-- "man/bluechi-agent.selinux.8.md:2" +--8<-- "man/bluechi-agent-selinux.8.md:2" diff --git a/doc/docs/man/bluechi-controller-selinux.md b/doc/docs/man/bluechi-controller-selinux.md index a45f2216ea..2ee13c21c1 100644 --- a/doc/docs/man/bluechi-controller-selinux.md +++ b/doc/docs/man/bluechi-controller-selinux.md @@ -1,2 +1,2 @@ ---8<-- "man/bluechi-controller.selinux.8.md:2" +--8<-- "man/bluechi-controller-selinux.8.md:2" diff --git a/doc/mkdocs.yml b/doc/mkdocs.yml index c9f3b864de..0713d24a40 100644 --- a/doc/mkdocs.yml +++ b/doc/mkdocs.yml @@ -9,7 +9,7 @@ nav: - Home: index.md - Architecture: architecture.md - Getting Started: - - getting_started/index.md + - Installation: getting_started/installation.md - Single Node Setup: getting_started/single_node.md - Multi-Node Setup: getting_started/multi_node.md - Using bluechictl: getting_started/examples_bluechictl.md