Skip to content

Commit 36820e2

Browse files
committed
Update installation documentation
1 parent 58ed643 commit 36820e2

File tree

3 files changed

+38
-49
lines changed

3 files changed

+38
-49
lines changed

INSTALL.deb.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
## Requirements
44

5-
Dispenser requires Docker to be installed in the system
6-
as well as [pass](https://www.passwordstore.org/).
5+
Dispenser requires Docker to be installed in the system.
76

87
## Install Docker
98

@@ -15,13 +14,15 @@ can change so please refer to the official documentation.
1514

1615
## Install Dispenser
1716

18-
```sh
19-
wget ...
20-
```
17+
Download the package matching your operating system:
2118

19+
* **Debian 12**: `dispenser-0.21.0-0-debian-12.x86_64.deb`
20+
* **Debian 13**: `dispenser-0.21.0-0-debian-13.x86_64.deb`
21+
* **Ubuntu 24.04**: `dispenser-0.21.0-0-ubuntu-24.x86_64.deb`
2222

2323
```sh
24-
sudo apt install ./dispenser-0.21.0-0.x86_64.deb
24+
# Example for Ubuntu 24.04
25+
sudo apt install ./dispenser-0.21.0-0-ubuntu-24.x86_64.deb
2526
```
2627

2728
You can validate that it was successfully installed by switching to the

INSTALL.redhat.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
## Requirements
44

5-
Dispenser requires Docker to be installed in the system
6-
as well as [pass](https://www.redhat.com/en/blog/management-password-store).
5+
Dispenser requires Docker to be installed in the system.
76

87
`pass` is only available on [EPEL](https://www.redhat.com/en/blog/whats-epel-and-how-do-i-use-it)
98
so make sure it is enabled before proceeding.
@@ -17,13 +16,14 @@ can change so please refer to the official documentation.
1716

1817
## Install Dispenser
1918

20-
```sh
21-
wget ...
22-
```
19+
Download the package matching your operating system:
2320

21+
* **RHEL 8 / Rocky 8**: `dispenser-0.21.0-0.rhel-8.x86_64.rpm`
22+
* **RHEL 9 / Rocky 9**: `dispenser-0.21.0-0.rhel-9.x86_64.rpm`
2423

2524
```sh
26-
sudo dnf install ./dispenser-0.21.0-0.x86_64.rpm
25+
# Example for RHEL 9
26+
sudo dnf install ./dispenser-0.21.0-0.rhel-9.x86_64.rpm
2727
```
2828

2929
You can validate that it was successfully installed by switching to the

README.md

Lines changed: 25 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -36,24 +36,28 @@ Before installing Dispenser, ensure the following are installed on your server:
3636

3737
## Installation
3838

39-
Download the latest `.deb` or `.rpm` package from the [releases page](https://github.com/ixpantia/dispenser/releases).
39+
Download the package matching your operating system from the [releases page](https://github.com/ixpantia/dispenser/releases).
4040

4141
### Debian / Ubuntu
4242

43+
Available for Debian 12, Debian 13, and Ubuntu 24.04.
44+
4345
```sh
44-
# Download the .deb package
45-
# wget https://github.com/ixpantia/dispenser/releases/download/v0.21.0/dispenser-0.21.0-0.x86_64.deb
46+
# Example for Ubuntu 24.04
47+
# wget https://github.com/ixpantia/dispenser/releases/download/v0.21.0/dispenser-0.21.0-0-ubuntu-24.x86_64.deb
4648

47-
sudo apt install ./dispenser-0.21.0-0.x86_64.deb
49+
sudo apt install ./dispenser-0.21.0-0-ubuntu-24.x86_64.deb
4850
```
4951

5052
### RHEL / CentOS / Fedora
5153

54+
Available for RHEL 8 and RHEL 9 (and compatible distributions like Rocky Linux).
55+
5256
```sh
53-
# Download the .rpm package
54-
# wget ...
57+
# Example for RHEL 9
58+
# wget https://github.com/ixpantia/dispenser/releases/download/v0.21.0/dispenser-0.21.0-0.rhel-9.x86_64.rpm
5559

56-
sudo dnf install ./dispenser-0.21.0-0.x86_64.rpm
60+
sudo dnf install ./dispenser-0.21.0-0.rhel-9.x86_64.rpm
5761
```
5862

5963
The installation process will:
@@ -524,42 +528,26 @@ dispenser -s stop
524528
525529
## Building from Source
526530
527-
### RPM (RHEL)
528-
529-
Before you try to build an rpm package, make sure you have the following
530-
installed:
531+
Dispenser uses `just` as a command runner and supports Docker-based builds to ensure compatibility with different operating systems.
531532
532-
- `cargo`: Rust package manager and build tool
533-
- `rustc`: Rust compiler
534-
- `make`: Run make files
535-
- `rpmbuild`: Tool to build RPMs
533+
### Prerequisites
536534
537-
Once these dependencies are installed run:
535+
- [Docker](https://docs.docker.com/engine/install/)
536+
- [Just](https://github.com/casey/just)
538537
539-
```
540-
make build-rpm
541-
```
538+
### Build for a specific OS
542539
543-
This should create a file called something along the lines of
544-
`../dispenser-$VERSION.x86_64.rpm`. There may be minor variations on the Linux
545-
distribution where you are building the package.
540+
You can build packages for specific operating systems even if you are not running them locally, as the build process runs inside Docker.
546541
547-
### Deb (Debian & Ubuntu)
548-
549-
Before you try to build a deb package, make sure you have the following
550-
installed:
551-
552-
- `cargo`: Rust package manager and build tool
553-
- `rustc`: Rust compiler
554-
- `make`: Run make files
555-
- `dpkg-dev`: Tool to build DEB files
542+
```sh
543+
# Build for Debian 12
544+
just build-debian-12
556545
557-
Once these dependencies are installed run:
546+
# Build for Ubuntu 24.04
547+
just build-ubuntu-24
558548
559-
```
560-
make build-deb
549+
# Build for RHEL 9
550+
just build-rhel-9
561551
```
562552
563-
This should create a file called something along the lines of
564-
`./dispenser.deb`. There may be minor variations on the Linux
565-
distribution where you are building the package.
553+
The resulting packages will be named with the OS suffix (e.g., `dispenser-0.21.0-0-ubuntu-24.x86_64.deb`).

0 commit comments

Comments
 (0)