Skip to content

Commit

Permalink
Updated readthedocs section for installing BlueChi on Debian
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Engel <[email protected]>
  • Loading branch information
engelmi committed Aug 8, 2024
1 parent 509f856 commit a57520b
Show file tree
Hide file tree
Showing 6 changed files with 50 additions and 19 deletions.
2 changes: 2 additions & 0 deletions README.developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
- [Documentation](#documentation)
- [Building MAN Pages](#building-man-pages)
- [Packaging](#packaging)
- [RPM](#rpm)
- [DEB](#deb)

## Development

Expand Down
16 changes: 0 additions & 16 deletions doc/docs/getting_started/index.md

This file was deleted.

45 changes: 45 additions & 0 deletions doc/docs/getting_started/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<!-- markdownlint-disable-file MD010 MD013 MD014 MD024 MD046 -->
# 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)
2 changes: 1 addition & 1 deletion doc/docs/man/bluechi-agent-selinux.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!-- markdownlint-disable-file MD041 -->
--8<-- "man/bluechi-agent.selinux.8.md:2"
--8<-- "man/bluechi-agent-selinux.8.md:2"
2 changes: 1 addition & 1 deletion doc/docs/man/bluechi-controller-selinux.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!-- markdownlint-disable-file MD041 -->
--8<-- "man/bluechi-controller.selinux.8.md:2"
--8<-- "man/bluechi-controller-selinux.8.md:2"
2 changes: 1 addition & 1 deletion doc/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a57520b

Please sign in to comment.