Commit d57f0ca2 authored by Ansgar Burchardt's avatar Ansgar Burchardt
Browse files

add at least some information to README.md

parent aff8985c
Pipeline #8280 passed with stage
in 6 minutes and 38 seconds
Role Name
=========
function.nextcloud
==================
A brief description of the role goes here.
This role manages a Nextcloud installation.
Currently two different installation scenarios are supported:
- Installation on a single server running all of Nginx, MariaDB and PHP.
- Installation on several systems with dedicated systems for loadbalancer (HAProxy),
application servers, MariaDB database servers and Redis servers.
Automatic failover for MaraiDB and Redis is not yet supported.
Requirements
------------
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
This role requires the [SDM framework](https://sdm.mn.tu-dresden.de/).
Role Variables
--------------
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
TODO
Dependencies
------------
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
TODO. See `requirements.yml` for now.
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:
- hosts: servers
roles:
- { role: username.rolename, x: 42 }
See the "converge.yml" playbooks in the "molecule" directory for examples how to use this role.
License
-------
BSD
Proprietary.
Author Information
------------------
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
Ansgar Burchardt <ansgar.burchardt@tu-dresden.de>
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment