Skip to content

Commit 527bff3

Browse files
authored
Merge pull request #66 from tomodachi/update_readme_role_names
Update readme with new role names
2 parents 79f85f1 + 8f8c8bd commit 527bff3

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# pi-ansible-automation
22
A set of roles (mostly) tested & optimized towards raspberry PI running Raspberry PI OS (Trixie Debian arm64)
33

4-
## avahi-discoverable
4+
## avahi_discoverable
55
enables avahi hostname mDNS broadcasting so you can reach host on hostname.local
66

77

@@ -24,17 +24,17 @@ by default in anonymous mode allowing anyone on your network to stream to your d
2424
| spotify_connect_name:| my-hifi | no |
2525

2626

27-
## roc-streaming
27+
## roc_streaming
2828
Installs the roc sink modules for pulseaudio allowing streaming audio from
2929
any pulseaudio/pipewire sound server giving a apple air-share like streaming experience
3030
for Linux users (only better) see /roles/roc-streaming/README.MD for more details.
3131
Currently limited to raspberrypi OS 11 (debian old stable) as the roc modules are compiled
3232
towards that target
3333

34-
## steamlink-pi
34+
## steamlink_pi
3535
Installs steamlink along with PS3 controller (wireless) support
3636

37-
## unattended-upgrades
37+
## unattended_upgrades
3838
Configures scheduled upgrades & reboots
3939

4040
| Variable name | Example | Mandatory |
@@ -46,15 +46,15 @@ Configures scheduled upgrades & reboots
4646
| apt_get_autoremove_ndays: | 18 | no |
4747

4848

49-
## dnsmasq-tftp
49+
## dnsmasq_tftp
5050
Configures dnsmasq to annouce tftp server for PXE boot
5151

5252
| Variable name | Example | Mandatory |
5353
| -------------------- |:-------------:| :----------:|
5454
| tftp_server: | 10.0.5.41 | yes |
5555

5656

57-
## tftpd-server
57+
## tftpd_server
5858
Configures tftp server for PXE boot
5959

6060
| Variable name | Example | Mandatory |
@@ -63,14 +63,14 @@ Configures tftp server for PXE boot
6363
| bootfs_path: | /mnt/bootfs | yes |
6464

6565

66-
## nfs-boot-pi
66+
## nfs_boot_pi
6767
Configures a raspberry pi to boot diskless of a NFS share
6868
| Variable name | Example | Mandatory |
6969
| -------------------- |:-------------:| :----------:|
7070
| rootfs_path: | /mnt/rootfs | yes |
7171
| bootfs_path: | /mnt/bootfs | yes |
7272

73-
## dns-over-tls
73+
## dns_over_tls
7474
DNS over TLS using Cloudflares clourflared for DNS proxying.
7575

7676
| Variable name | Example | Mandatory |
@@ -81,7 +81,7 @@ DNS over TLS using Cloudflares clourflared for DNS proxying.
8181
| dns_hosts | dns_hosts: -
8282
facebook.com: 0.0.0.0 | no |
8383

84-
## single-nic-firewall
84+
## single_nic_firewall
8585
Sets up a single nic NAT:ing Firewall with a DHCP server using VLANs & nftables for firewalling.
8686
This required that you have a Switch with VLAN capabilities.
8787

@@ -114,5 +114,5 @@ static_dhcp_clients:
114114
```
115115
`
116116

117-
## Headless powersave
117+
## headless_powersave
118118
Disables HDMI and on-device leds to save power

0 commit comments

Comments
 (0)