docs: standardize readme format
This commit is contained in:
parent
57fdc23cae
commit
a0404abf13
1 changed files with 18 additions and 8 deletions
26
readme.md
26
readme.md
|
|
@ -1,13 +1,23 @@
|
||||||
# Overview
|
# Ansible Role: Atuin
|
||||||
|
|
||||||
This role configures [Atuin](<https://atuin.sh/>) server, for reasons.
|
Install and configure [Atuin](https://atuin.sh/) - a shell history sync server.
|
||||||
|
|
||||||
## Supported Operating Systems
|
## Variables
|
||||||
|
|
||||||
| Operating System | Version |
|
| Variable | Required | Default | Description |
|
||||||
| --- | ----- |
|
|----------|----------|---------|-------------|
|
||||||
| Debian | 13 |
|
| `atuin_version` | No | `18.13.6` | Atuin version to install |
|
||||||
|
| `atuin_db_host` | No | `localhost` | Database host |
|
||||||
|
| `atuin_db_name` | No | `atuin` | Database name |
|
||||||
|
| `atuin_db_user` | No | `atuin` | Database user |
|
||||||
|
| `atuin_db_pass` | Yes | `atuin` | Database password |
|
||||||
|
|
||||||
## Tags
|
## Example
|
||||||
|
|
||||||
This role has no tags.
|
```yaml
|
||||||
|
atuin_version: "18.13.6"
|
||||||
|
atuin_db_host: "localhost"
|
||||||
|
atuin_db_name: "atuin"
|
||||||
|
atuin_db_user: "atuin"
|
||||||
|
atuin_db_pass: "secure_password"
|
||||||
|
```
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue