diff --git a/README.md b/README.md index 9016678..03a01f8 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ A comprehensive Ansible collection for deploying and managing Docker Compose app ## Overview -A curated collection of Docker Compose roles for self-hosted applications. Each role depends on the base role in the [`patrickj.docker_compose_app`](https://git.jaroszew.ski/ansible/ansible-role-docker-compose-app) collection (FQCN `patrickj.docker_compose_app.app`) to provide standardized deployment, configuration management, backup procedures, and lifecycle operations across diverse containerized services. +A curated collection of Docker Compose roles for self-hosted applications. Each role depends on the base role in the [`patrickj.docker_compose_app`](https://git.jaroszew.ski/ansible/ansible-collection-docker-compose-app) collection (FQCN `patrickj.docker_compose_app.app`) to provide standardized deployment, configuration management, backup procedures, and lifecycle operations across diverse containerized services. -Consult the [base role documentation](https://git.jaroszew.ski/ansible/ansible-role-docker-compose-app/src/branch/main/roles/app/README.md) for guidance on creating custom roles, variable conventions, and integration patterns. +Consult the [base role documentation](https://git.jaroszew.ski/ansible/ansible-collection-docker-compose-app/src/branch/main/roles/app/README.md) for guidance on creating custom roles, variable conventions, and integration patterns. ## Features @@ -21,13 +21,22 @@ Consult the [base role documentation](https://git.jaroszew.ski/ansible/ansible-r ## Installation -### From Git Repository +Both this collection and its base dependency (`patrickj.docker_compose_app`) are hosted on Gitea, not on Ansible Galaxy. Install them together via a `requirements.yml` in your playbook repo: -```bash -ansible-galaxy collection install https://git.jaroszew.ski/ansible/ansible-collection-docker-apps.git +```yaml +collections: + - name: https://git.jaroszew.ski/ansible/ansible-collection-docker-compose-app.git + type: git + - name: https://git.jaroszew.ski/ansible/ansible-collection-docker-apps.git + type: git ``` -### From Local Development +Install with: +```bash +ansible-galaxy collection install -r requirements.yml +``` + +### From local development ```bash # From the collection directory diff --git a/galaxy.yml b/galaxy.yml index ea94602..6d27340 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -16,7 +16,6 @@ tags: - homelab dependencies: "community.docker": ">=1.10.0" - "patrickj.docker_compose_app": ">=1.0.0" repository: https://git.jaroszew.ski/ansible/ansible-collection-docker-apps documentation: https://git.jaroszew.ski/ansible/ansible-collection-docker-apps/README.md homepage: https://git.jaroszew.ski/ansible/ansible-collection-docker-apps