Skip to content

Commit

Permalink
doc(readme): Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AngeCyp committed Nov 19, 2024
1 parent 2a4db90 commit 2e25675
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 4 deletions.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,46 @@
# packaging
Alumet docker images and distro-specific packages

When you're downloading the rpm, use a compatible glibc version particularly if you're not on fedora.
# Table of Contents
- [packaging](#packaging)
- [Table of Contents](#table-of-contents)
- [How to install ?](#how-to-install-)
- [How to uninstall](#how-to-uninstall)
- [What does the RPM do ?](#what-does-the-rpm-do-)


When you're downloading the rpm, use a compatible version particularly if you're not on fedora.

| Version of fedora | Version of libc |
|------------------- |----------------- |
| Fedora Linux 42 | glibc 2.40 |
| Fedora Linux 41 | glibc 2.40 |
| Fedora Linux 40 | glibc 2.39 |

# How to install ?

```bash
sudo rpm -i <rpm file>
```

# How to uninstall

List all installed Alumet package:

```bash
rpm -qa | grep -i alumet
```

Remove the correct Alumet package
```bash
sudo rpm -e <package>
```

# What does the RPM do ?

The RPM create a folder **alumet** inside the */etc/* folder. Here will be put the **alumet-config.toml** file which is the config file for Alumet by default.
The RPM also put inside the */bin/* folder the Alumet binary. As usually */bin/* folder is in the path, you can just run Alumet like (it depends on which rpm you had installed):

```bash
alumet-local-agent
```
3 changes: 0 additions & 3 deletions specs/alumet.spec
Original file line number Diff line number Diff line change
Expand Up @@ -53,17 +53,14 @@ chmod 777 %{buildroot}%{_sysconfdir}/alumet


%files alumet-local-agent
%{_bindir}/alumet/alumet-local-agent
%{_bindir}/alumet-local-agent
%dir %{_sysconfdir}/alumet/

%files alumet-relay-server
%{_bindir}/alumet/alumet-relay-server
%{_bindir}/alumet-relay-server
%dir %{_sysconfdir}/alumet/

%files alumet-relay-client
%{_bindir}/alumet/alumet-relay-client
%{_bindir}/alumet-relay-client
%dir %{_sysconfdir}/alumet/

Expand Down

0 comments on commit 2e25675

Please sign in to comment.