Commit 5bf9016f authored by Jonathan Blum's avatar Jonathan Blum

Update README.md

parent c42d425d
......@@ -6,25 +6,23 @@ Install PrivateBin on your webserver
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.
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.
* **Required**
**privatebin_url**: domain name to access the private bin (ex: bin.example.tld)
* **Optional** (but highly recommanded)
**privatebin_ssl_cert**: SSL Certificate
**privatebin_ssl_key**: SSL Private Key
**privatebin_ssl_chain**: SSL Chain certificate (optional)
* **Default**
privatebin_install_path: /srv/privatebin
privatebin_version: "1.3.1"
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.
Example Playbook
----------------
......@@ -33,8 +31,12 @@ Including an example of how to use your role (for instance, with variables
passed in as parameters) is always nice for users too:
- hosts: webservers
roles:
- { role: itopie.privatebin, x: 42 }
become: yes
tasks:
- include_vars: vars/privatebin.yml
- include_role:
name: itopie.privatebin
License
-------
......
Markdown is supported
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