wneessen/apg-go
1
1
Fork 0
mirror of https://github.com/wneessen/apg-go.git synced 2024-11-22 13:50:49 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update README with detailed installation instructions

Browse source 
The README file has been updated with thorough installation instructions. Changes range from introducing binary and package releases, including their verification using GPG signature, to refactoring the source code installation steps. Additionally, instructions for specific platforms like FreeBSD, Arch Linux, Debian/Redhat/Alpine, etc., have been improved for clarity.
This commit is contained in:
Winni Neessen 2024-03-16 10:27:56 +01:00
parent 3b1ce9009a
commit 4ee866bd61
Signed by: wneessen
GPG key ID: 5F3AF39B820C119D
1 changed files with 64 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

97
README.md
View file

@ -36,80 +36,111 @@ There is a ready-to-use Docker image hosted on Github.
$ docker run ghcr.io/wneessen/apg-go:main $ docker run ghcr.io/wneessen/apg-go:main
``` ```
### Ports/Packages ### Binary releases/Packages
#### FreeBSD
apg-go can be found as `/security/apg` in the [FreeBSD ports](https://cgit.freebsd.org/ports/tree/security/apg)
tree.
#### Arch Linux
Find apg-go in [Arch Linux AUR](https://aur.archlinux.org/packages/apg-go/). \
Alternatively use the pre-build `zst`-package of the [latest release](https://github.com/wneessen/apg-go/releases) in
this git repository
### Binary releases
On the [Github release page](https://github.com/wneessen/apg-go/releases) you will always find pre-build binaries On the [Github release page](https://github.com/wneessen/apg-go/releases) you will always find pre-build binaries
for all supported OS and architectures. You will also find pre-built packages for the most common Linux distributions. for all supported OS and architectures. You will also find pre-built packages for the most common Linux distributions.
Each file is digitally signed via GPG. After downloading the corresponding file, make sure that the file is verified Each file is digitally signed via GPG. After downloading the corresponding file, make sure that the file is verified
with the GPG signature. The public GPG key is: with the GPG signature. The public GPG key is:
["Winni Neessen" (Software signing key) <wn@neessen.dev>](https://keys.openpgp.org/vks/v1/by-fingerprint/10B5700F5ECCB06532CEC873C3D38948DA536E89) ["Winni Neessen" (Software signing key) <wn@neessen.dev>](https://keys.openpgp.org/vks/v1/by-fingerprint/10B5700F5ECCB06532CEC873C3D38948DA536E89)
#### Linux/BSD/MacOS #### FreeBSD
apg-go can be found as `/security/apg` in the [FreeBSD ports](https://cgit.freebsd.org/ports/tree/security/apg)
tree.
#### Arch Linux
Find apg-go in [Arch Linux AUR](https://aur.archlinux.org/packages/apg-go/). Alternatively use the pre-build `zst`-package of the [latest release](https://github.com/wneessen/apg-go/releases) in
this git repository
#### Debian/Redhat/Alpine
Pre-build packages in `.deb`, `.rpm` and `.apk` format can be found on [release page](https://github.com/wneessen/apg-go/releases) in
this git repository
#### Binary installation on Linux/BSD/MacOS
* Download release * Download release
```sh ```sh
$ curl -LO https://github.com/wneessen/apg-go/releases/download/v<version>/apg-v<version>-<os>-<architecture>.tar.gz $ curl -LO https://github.com/wneessen/apg-go/releases/download/v<version>/apg-go_<version>_<os>_<architecture>.tar.gz
$ curl -LO https://github.com/wneessen/apg-go/releases/download/v<version>/apg-v<version>-<os>-<architecture>.tar.gz.sha256 $ curl -LO https://github.com/wneessen/apg-go/releases/download/v<version>/apg-go_<version>_<os>_<architecture>.tar.gz.sig
``` ```
* Verify the checksum * Import the GPG signing key
```sh ```sh
$ sha256 apg-v<version>-<os>-<architecture>.tar.gz $ gpg --keyserver keys.openpgp.org --recv-keys C3D38948DA536E89
$ cat apg-v<version>-<os>-<architecture>.tar.gz.sha256 gpg: key C3D38948DA536E89: public key "Winni Neessen (Software signing key) <wn@neessen.dev>" imported
gpg: Total number processed: 1
gpg: imported: 1
``` ```
**Make sure the checksum of the downloaded file and the checksum in the .sha256 match** * Verify the signature
```sh
$ gpg --verify apg-go_<version>_<os>_<architechture>.tar.gz.sig apg-go_<version>_<os>_<architecture>.tar.gz
gpg: Signature made Thu Mar 14 11:27:43 2024 CET
gpg: using EDDSA key 10B5700F5ECCB06532CEC873C3D38948DA536E89
gpg: issuer "wn@neessen.dev"
gpg: Good signature from "Winni Neessen (Software signing key) <wn@neessen.dev>" [unknown]
Primary key fingerprint: 10B5 700F 5ECC B065 32CE C873 C3D3 8948 DA53 6E89
```
**Make sure the signature of the downloaded file verifies as "good"**
* Extract archive * Extract archive
```sh ```sh
$ tar xzf apg-v<version>-<os>-<architecture>.tar.gz $ tar xzf apg-<version>_<os>_<architecture>.tar.gz
``` ```
* Execute * Execute
```sh ```sh
$ ./apg $ ./apg -v
apg-go // A "Automated Password Generator"-clone v1.0.0
OS: <version> // Arch: <architecture>
(C) 2021-2024 by Winni Neessen
``` ```
#### Windows #### Windows
* Download release * Download release
```PowerShell ```PowerShell
PS> Invoke-RestMethod -Uri https://github.com/wneessen/apg-go/releases/download/v<version>/apg-v<version>-windows-<architecture>.zip -OutFile apg-v<version>-windows-<architecure>.zip PS> Invoke-RestMethod -Uri https://github.com/wneessen/apg-go/releases/download/v<version>/apg-go_<version>_windows_<architecture>.zip -OutFile apg-<version>-windows-<architecure>.zip
PS> Invoke-RestMethod -Uri https://github.com/wneessen/apg-go/releases/download/v<version>/apg-v<version>-windows-<architecture>.zip.sha256 -OutFile apg-v<version>-windows-<architecure>.zip.sha256 PS> Invoke-RestMethod -Uri https://github.com/wneessen/apg-go/releases/download/v<version>/apg-go_<version>_windows_<architecture>.zip.sig -OutFile apg-<version>-windows-<architecure>.zip.sig
``` ```
* Verify the checksum * Import the GPG signing key
```PowerShell ```PowerShell
PS> Get-FileHash apg-v<version>-windows-<architecture>.zip | Format-List PS> gpg --keyserver keys.openpgp.org --recv-keys C3D38948DA536E89
PS> type apg-v<version>-windows-<architecture>.zip.sha256 gpg: key C3D38948DA536E89: public key "Winni Neessen (Software signing key) <wn@neessen.dev>" imported
gpg: Total number processed: 1
gpg: imported: 1
``` ```
**Make sure the checksum of the downloaded file and the checksum in the .sha256 match** * Verify the signature
```PowerShell
PS> gpg --verify apg-go_<version>_<os>_<architechture>.tar.gz.sig apg-go_<version>_<os>_<architecture>.tar.gz
gpg: Signature made Thu Mar 14 11:27:43 2024 CET
gpg: using EDDSA key 10B5700F5ECCB06532CEC873C3D38948DA536E89
gpg: issuer "wn@neessen.dev"
gpg: Good signature from "Winni Neessen (Software signing key) <wn@neessen.dev>" [unknown]
Primary key fingerprint: 10B5 700F 5ECC B065 32CE C873 C3D3 8948 DA53 6E89
```
**Make sure the signature of the downloaded file verifies as "good"**
* Extract archive * Extract archive
```PowerShell ```PowerShell
PS> Expand-Archive -LiteralPath apg-v<version>-windows-<architecture> PS> Expand-Archive -LiteralPath apg-<version>-windows-<architecture>.zip
``` ```
* Execute * Execute
```PowerShell ```PowerShell
PS> cd apg-v<version>-windows-<architecture>
PS> apg.exe PS> apg.exe
``` ```
### Sources ### Sources
* Download sources * Download sources
```sh ```shell
$ curl -LO https://github.com/wneessen/apg-go/archive/refs/tags/v<version>.tar.gz $ curl -LO https://github.com/wneessen/apg-go/archive/refs/tags/v<version>.tar.gz
``` ```
* Extract source * Extract source
```sh ```shell
$ tar xzf v<version>.tar.gz $ tar xzf v<version>.tar.gz
``` ```
* Build binary * Download dependencies
```sh ```shell
$ cd apg-go-<version> $ cd apg-go-<version>
$ go build -o apg ./... $ go mod tidy
$ go mod download
$ go mod verify
```
* Build binary
```shell
$ go build -o apg github.com/wneessen/apg-go/cmd/apg
``` ```
* Execute the brand new binary * Execute the brand new binary
```sh ```shell
$ ./apg $ ./apg
``` ```