Skip to content

Commit

Permalink
Update README and CHANGELOG for new archs and Nix
Browse files Browse the repository at this point in the history
  • Loading branch information
mtardy committed Jun 21, 2022
1 parent d629e09 commit 367bb6b
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 7 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Changelog

## `1.2.1` - 2022-06-21

### Added
- New builds for macOS amd64 and Linux arm64. the macOS build is not really
useful since kdigger is supposed to be run inside of pods, inside nodes, but
it can be used to scan the admission control for example, or any remote
plugins. However, Linux arm64 can be quite useful in case of arm64 node
pools.
- You can now install kdigger via Nix! Thanks to generous contributor
@06kellyjac, see the [PR on kdigger repo](https://github.com/quarkslab/kdigger/pull/2)
and [in nixpkgs](https://github.com/NixOS/nixpkgs/pull/177868).

## `1.2.0` - 2022-06-16
### Added
- A new plugin, apiresources to retrieve all information that can be leaked by
Expand Down
33 changes: 26 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,36 +53,55 @@ canal](https://i.servimg.com/u/f41/11/93/81/35/digger10.jpg)

## Installation

`kdigger` is available on Linux amd64, arm64 and macOS amd64.

**Please note that `kdigger` should be mostly run inside of pods on not on your
host machine.**

### Via releases

For installation instructions from binaries please visit the [Releases
Page](https://github.com/quarkslab/kdigger/releases).
For installation instructions from binaries please visit the [releases
page](https://github.com/quarkslab/kdigger/releases).

### Build from source

You need [`golangci-lint`](https://github.com/golangci/golangci-lint) to use
the `build` default target that will try to build for your architecture. You
can use `make install-linter` to install `golangci-lint` on the host. Or you
can use `make fast-build` to avoid linting.
```bash
$ git clone https://github.com/quarkslab/kdigger
$ make
git clone https://github.com/quarkslab/kdigger
make
```

Then you can move the binary somewhere included in your PATH, for example:

```bash
$ sudo install kdigger /usr/local/bin
sudo install kdigger /usr/local/bin
```

### With Nix

You can use Nix with a new shell environments thanks to [a contributor
PR](https://github.com/quarkslab/kdigger/pull/2) that [added kdigger to
nixpkgs](https://github.com/NixOS/nixpkgs/pull/177868).

```bash
nix-shell -p kdigger
```

### Via Go

```bash
$ go install github.com/quarkslab/kdigger@master
go install github.com/quarkslab/kdigger@master
```

## Usage

What you generally want to do is running all the buckets with `dig all` or just
`d a`:
```bash
$ kdigger dig all
kdigger dig all
```

Help is provided by the CLI itself, just type `kdigger` to see the options:
Expand Down

0 comments on commit 367bb6b

Please sign in to comment.