aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-04 08:21:15 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-04 08:21:15 -0500
commit2f9175cfd7ea13561b5023bc1e98a2afbaaa6be5 (patch)
treec843dd6a02457333f8cbb7ee577e528b33773d39 /README.md
parent604f6b8c664e98fd3b3f0930999c39837c74d1a6 (diff)
downloadselfhosted-2f9175cfd7ea13561b5023bc1e98a2afbaaa6be5.tar.gz
selfhosted-2f9175cfd7ea13561b5023bc1e98a2afbaaa6be5.zip
update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/README.md b/README.md
index c0cfd19..ea18211 100644
--- a/README.md
+++ b/README.md
@@ -44,9 +44,9 @@ from official repos or [EPEL](https://docs.fedoraproject.org/en-US/epel/),
and managed using systemd. For services that lack official RPMs, the software is
built locally from the upstream source repository during the playbook.
-All network services listen on the local IP of the virtual machine. If you want
-to expose a service to the internet, it is assumed that you will configure your
-firewall for 1:1 NAT.
+All network services listen on the local IP of the host. If you want to expose
+a service to the internet, it is assumed that you will configure your firewall
+for 1:1 NAT.
There is no IPv6 support whatsoever. If my ISP ever rolls out IPv6, I'll look
into it.
@@ -55,8 +55,8 @@ into it.
Modular [Ansible roles](roles) are used to manage VMs and configure each service.
-| Role | Description |
-----------------------------------------------|-------------|
+| Role | Description |
+--------------------------------------------|-------------|
[proxmox\_instance](roles/proxmox_instance) | Automatically provisions a [Proxmox](https://www.proxmox.com/) VM with the given hardware and cloud-init configuration
[freeipa\_server](roles/freeipa_server) | [FreeIPA](https://www.freeipa.org/) provides provides identity management, access control, certificate management, and Single Sign-On for all services via Kerberos/GSSAPI
[yum\_mirror](roles/yum_mirror) | Mirrors all package repositories locally
@@ -83,13 +83,15 @@ Modular [Ansible roles](roles) are used to manage VMs and configure each service
[nsd](roles/nsd) | Authoritative DNS server
[nagios\_server](roles/nagios_server) | Monitors all hosts and services, automatically generated configuration
[znc](roles/znc) | [ZNC](https://znc.in/) IRC bouncer
-[cups](roles/cups) | Centralized network printing
+[cups\_server](roles/cups) | Centralized network printing
[unifi](roles/unifi) | [UniFi](https://www.ui.com/) controller for managing Ubiquiti access points
[freeradius](roles/freeradius) | WPA Enterprise authentication for WiFi using FreeIPA credentials or SSL certificates
All services authenticate against the local FreeIPA domain. On a domain-joined
workstation, Kerberos/GSSAPI is used for single sign-on.
+The [common.yml](playbooks/common.yml) playbook is a prerequisite for all services.
+It joins the host to FreeIPA, adds the local yum repos, configures DNS and NTP, etc.
## Todo