mirror of
https://github.com/ryantm/agenix.git
synced 2024-09-11 06:05:38 +03:00
Merge pull request #140 from ryantm/rtm-1-29-doc
doc: collapse installation sections
This commit is contained in:
commit
49798e535e
43
README.md
43
README.md
@ -7,18 +7,10 @@
|
|||||||
* [Problem and solution](#problem-and-solution)
|
* [Problem and solution](#problem-and-solution)
|
||||||
* [Features](#features)
|
* [Features](#features)
|
||||||
* [Installation](#installation)
|
* [Installation](#installation)
|
||||||
* [niv](#install-via-niv) (Current recommendation)
|
* [niv](#install-via-niv)
|
||||||
* [module](#install-module-via-niv)
|
|
||||||
* [CLI](#install-cli-via-niv)
|
|
||||||
* [nix-channel](#install-via-nix-channel)
|
* [nix-channel](#install-via-nix-channel)
|
||||||
* [module](#install-module-via-nix-channel)
|
|
||||||
* [CLI](#install-cli-via-nix-channel)
|
|
||||||
* [fetchTarball](#install-via-fetchtarball)
|
* [fetchTarball](#install-via-fetchtarball)
|
||||||
* [module](#install-module-via-fetchtarball)
|
|
||||||
* [CLI](#install-cli-via-fetchTarball)
|
|
||||||
* [flakes](#install-via-flakes)
|
* [flakes](#install-via-flakes)
|
||||||
* [module](#install-module-via-flakes)
|
|
||||||
* [CLI](#install-cli-via-flakes)
|
|
||||||
* [Tutorial](#tutorial)
|
* [Tutorial](#tutorial)
|
||||||
* [Reference](#reference)
|
* [Reference](#reference)
|
||||||
* [`age` module reference](#age-module-reference)
|
* [`age` module reference](#age-module-reference)
|
||||||
@ -49,15 +41,13 @@ All files in the Nix store are readable by any system user, so it is not a suita
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Choose one of the following methods:
|
<details>
|
||||||
|
<summary>
|
||||||
* [niv](#install-via-niv)
|
|
||||||
* [nix-channel](#install-via-nix-channel)
|
|
||||||
* [fetchTarball](#install-via-fetchTarball)
|
|
||||||
* [flakes](#install-via-flakes)
|
|
||||||
|
|
||||||
### Install via [niv](https://github.com/nmattia/niv)
|
### Install via [niv](https://github.com/nmattia/niv)
|
||||||
|
|
||||||
|
</summary>
|
||||||
|
|
||||||
First add it to niv:
|
First add it to niv:
|
||||||
|
|
||||||
```ShellSession
|
```ShellSession
|
||||||
@ -84,8 +74,15 @@ To install the `agenix` binary:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>
|
||||||
|
|
||||||
### Install via nix-channel
|
### Install via nix-channel
|
||||||
|
|
||||||
|
</summary>
|
||||||
|
|
||||||
As root run:
|
As root run:
|
||||||
|
|
||||||
```ShellSession
|
```ShellSession
|
||||||
@ -113,8 +110,15 @@ To install the `agenix` binary:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>
|
||||||
|
|
||||||
### Install via fetchTarball
|
### Install via fetchTarball
|
||||||
|
|
||||||
|
</summary>
|
||||||
|
|
||||||
#### Install module via fetchTarball
|
#### Install module via fetchTarball
|
||||||
|
|
||||||
Add the following to your configuration.nix:
|
Add the following to your configuration.nix:
|
||||||
@ -152,8 +156,15 @@ To install the `agenix` binary:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>
|
||||||
|
|
||||||
### Install via Flakes
|
### Install via Flakes
|
||||||
|
|
||||||
|
</summary>
|
||||||
|
|
||||||
#### Install module via Flakes
|
#### Install module via Flakes
|
||||||
|
|
||||||
```nix
|
```nix
|
||||||
@ -192,6 +203,8 @@ but, if you want to (change the system based on your system):
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
## Tutorial
|
## Tutorial
|
||||||
|
|
||||||
1. The system you want to deploy secrets to should already exist and
|
1. The system you want to deploy secrets to should already exist and
|
||||||
|
Loading…
Reference in New Issue
Block a user