GregoryDosh
62ca08d011
All checks were successful
Version Bump Galaxy.yml / Version Bump Galaxy.yml (push) Successful in 6s
36 lines
1.2 KiB
Markdown
36 lines
1.2 KiB
Markdown
<!--
|
|
SPDX-License-Identifier: AGPL-3.0-or-later
|
|
SPDX-FileCopyrightText: 2025 Dosh LLC
|
|
-->
|
|
|
|
# Ansible Collection `dosh_llc.ansible_caddy`
|
|
|
|
A collection of Ansible roles to manage the various tasks in my homelab.
|
|
|
|
## Collection Installation
|
|
|
|
### Ansible Galaxy - `requirements.yml`
|
|
|
|
Add the following snippet to Ansible Galaxy's [`requirements.yml`](https://docs.ansible.com/ansible/latest/galaxy/user_guide.html#installing-roles-and-collections-from-the-same-requirements-yml-file) file.
|
|
|
|
```yaml
|
|
collections:
|
|
- name: ssh://git@git.auengun.net/dosh-llc/ansible-caddy.git
|
|
type: git
|
|
# Note: it's better to pin to a version/commit than main.
|
|
version: main
|
|
```
|
|
|
|
Then install using [`ansible-galaxy`](https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html).
|
|
|
|
```shell
|
|
ansible-galaxy collection install -r requirements.yml
|
|
```
|
|
|
|
## Roles
|
|
|
|
### [`dosh_llc.ansible_caddy.install`](./roles/install)
|
|
|
|
Installs a [custom](https://git.auengun.net/dosh-llc/bin-caddy) [Caddy](https://caddyserver.com) server enabling some rate limiting and other features for advanced configurations. Optionally installs a systemd service on compatible systems.
|
|
|
|
Read the [README.md](./roles/install/README.md) for usage and configuration details.
|