clippable/aws/playbooks/README.md
2022-01-02 15:10:00 -08:00

1.2 KiB

Role Name

This role is dedicated to making the setup and administration of a clippable server a little bit easier for those intending on running their own instance.

There are playbooks for maintaining this service both as a container and as a service running on System D.

Role Variables

Vars in: defaults/main.yml

  • remote_user: Default username to use for regular tasks

Set to admin by default.

  • remote_app_dir: Directory to install application files into

Set to /home/{{remote_user}}/app by default

This includes things like the server binary and HTML template files. You only need to worry about this if you're not going to run this in a container.

  • main_host

Set to main by default.

Host that you intend on targeting.

Dependencies

  • community.docker

This is only required if you are planning on using any of the docker playbooks.

Example Playbook

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:

License

GPL V3

Author Information

Author: Shockrah Email: dev@shockrah.xyz