improve docs

This commit is contained in:
uumas
2021-11-08 01:33:13 +02:00
parent 10a6c9e12b
commit 7d104e8efc
3 changed files with 33 additions and 24 deletions

View File

@@ -1,30 +1,7 @@
# Required variables # Required variables
These variables are required by some roles. Example values included. These variables might be required by multiple roles and need to be defined. Example values below.
``` ```
email: 'admin@domain.tld' email: 'admin@domain.tld'
``` ```
# Default variables
These variables have default values (shown below) which can be overridden.
```
install_packages:
- vim
- git
- etckeeper
- net-tools
- nmap
- ncdu
- fish
- parted
```
# Optional variables
These variables are not required and not defined by default. Example values included.
```
delete_packages:
- nano
- curl
```

16
docs/packages.md Normal file
View File

@@ -0,0 +1,16 @@
Installs packages defined in `install_packages` variable, which has the following defaults:
```
install_packages:
- vim
- git
- etckeeper
- net-tools
- nmap
- ncdu
- fish
- parted
```
Also deletes packages defined in `delete_packages` if defined

16
docs/users.md Normal file
View File

@@ -0,0 +1,16 @@
---
Creates users specified in the `users` variable. Syntax:
```
users:
- name: username
password: hashed password
ssh_pubkey: 'ssh-rsa...'
- name: 'user1'
password: '$6$...'
ssh_pubkey: 'ssh-ed25519...'
shell: '/usr/bin/fish'
```
Specifying `shell` is optional