diff --git a/README.md b/README.md index 6f0572ba..58937302 100644 --- a/README.md +++ b/README.md @@ -35,8 +35,10 @@ Installation methods: - [Fedora](/docs/installation.md#fedora) - [openSUSE/SLE](/docs/installation.md#opensusesle) - [Ubuntu/Debian](/docs/installation.md#ubuntudebian) + - [NixOS](/docs/installation.md#nixos) - [macOS (Homebrew and MacPorts)](/docs/installation.md#macos) - [Windows](/docs/installation.md#windows) + - [Docker](/docs/installation.md#docker) #### Binary installation diff --git a/docs/installation.md b/docs/installation.md index 284a15e6..f1679978 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -105,3 +105,32 @@ and install the package: sudo zypper refresh sudo zypper install kompose ``` + +#### NixOS + +To install from [Nixpkgs](https://github.com/NixOS/nixpkgs), use [nix-env](https://nixos.org/manual/nix/stable/command-ref/nix-env.html). + +```bash +nix-env --install -A nixpkgs.kompose +``` + +To run `kompose` without installing it, use [nix-shell](https://nixos.org/manual/nix/stable/command-ref/nix-shell.html). + +```bash +nix-shell -p kompose --run "kompose convert" +``` + + +#### Docker + +You can build an image from the offical repo for [Docker](https://docs.docker.com/engine/reference/commandline/build/) or [Podman](https://docs.podman.io/en/latest/markdown/podman-build.1.html): + +```bash +docker build -t kompose https://github.com/kubernetes/kompose.git +``` + +To run the built image against the current directory, run the following command: + +```bash +docker run --rm -it -v $PWD:/opt kompose sh -c "cd /opt && kompose convert" +```