From ec76b51931abb056b4f2ef68207df01dc67ddf0e Mon Sep 17 00:00:00 2001 From: "Antonio J. Delgado" Date: Tue, 27 Dec 2022 18:01:47 +0200 Subject: [PATCH] Update readme --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0f2dc62..d71e978 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ ## ansible-role-invidious -Work in progress... +Role to deploy an instance of Invidious https://invidious.io/ using docker composer. +Check their documentation for more information about post-install tasks and caveats. https://docs.invidious.io/installation/#docker # Requirements @@ -9,8 +10,26 @@ https://gitlab.com/antoniodelgado/ansible-role-apache_ssl_vhosts # Installation +Add it to your requirements.txt with the apache_ssl_vhosts (if you want it to handle Apache2) + +```yaml +roles: + - name: invidious + src: ssh://git@repos.susurrando.com:1122/srv/git.repos/ansible-role-invidious.git + scm: git + - name: apache_ssl_vhosts + src: ssh://git@repos.susurrando.com:1122/srv/git.repos/ansible-role-apache_ssl_vhosts + scm: git +``` + +# Configuration + +Check defaults/main.yml for some example configuration and the defaults. + # Usage +Just apply the role. + # Credits Antonio J. Delgado 2022 https://gitlab.com/antoniodelgado