Update documentation to better comply with ansible-galaxy format

GR360RY · GR360RY · commit f54ce89adfb8 · 2014-11-14T17:13:24.000+02:00
diff --git a/README.md b/README.md
@@ -1,13 +1,19 @@
 Snipe-IT Installation with Ansible
 ----------------------------------
-This repository contains installation scripts for deploying [Snipe-IT](http://snipeitapp.com/) with [Ansible](http://www.ansible.com) on Ubuntu. Installation can be performed on production/development server or tested with [Vagrant](http://www.vagrantup.com). 
+This repository contains [Ansible](http://www.ansible.com) Role for deploying [Snipe-IT](http://snipeitapp.com/) on Debian based systems. 
 
-## Requirements
-
-* Ubuntu 14.04
+* Quick Installation can be performed on production/development server with attached script.
+* Sample playbook is available for standalone installations.
+* [Vagrant](http://www.vagrantup.com) file is attached for quickly testing Snipe-IT on VM.
 
 ## Quick Installation
 
+__Requirements:__
+
+Ubuntu 12.04 and up. ( Testend on Ubuntu 14.04 )
+
+__Installation:__
+
 Connect to target Ubuntu machine and run:
 
 ```
@@ -24,7 +30,7 @@ Password:  `bar`
 Installation will be performed using the default configuration values.
 
 
-__Default Configuration Values:__
+## Default Configuration Values:
 
 | Variable Name                |   Default Value   | 
 |:-----------------------------|:-----------------:|
@@ -54,7 +60,7 @@ This Snipe-IT installation playbook can be executed directly on the target machi
 ### Clone the repository
 
     cd $HOME
-    git clone https://github.com/GR360RY/snipeit-ansible.git snipeit
+    git clone https://github.com/GR360RY/snipeit-ansible.git
 
 ### Modify the configuration
 
@@ -69,44 +75,45 @@ Edit `snipeit.yml` and overwrite the default values:
 
   vars:
 
-    snipeit_source: /var/www/another_folder
+    snipeit_source: /opt/snipe-it
 
-    snipeit_dbname: my_db
-    snipeit_dbuser: foo
-    snipeit_dbuser_password: bar
+    snipeit_dbname: snipeit
+    snipeit_dbuser: snipeit
+    snipeit_dbuser_password: secret
 
-    smtp_host: smtp.foo.com
+    smtp_host: smtp.example.com
     smtp_port: 25
 
     admin_first_name: Admin
     admin_last_name: Admin
-    admin_email: john@foo.com
-    admin_password: my_secret_password
+    admin_email: foo@example.com
+    admin_password: bar
 
-    disable_default_apache_site: False
+    disable_default_apache_site: True
     run_mysql_on_all_interfaces: False
 
-    # If you want to import users from Active Directory to Snipe-IT, modify the below values.
+    # If you want to import users from Active Directory to Snipe-IT, uncomment and modify the below values.
     # To import AD users, run /usr/local/bin/import_ad_users.py
 
-    ldap_uri: 'ldap://dc01.foo.com'
-    ldap_admin: 'CN=Administrator,DC=foo,DC=com'
-    ldap_passwd: 'your_secret_password'
-    users_ou: 'OU=Users,DC=foo,DC=com'
-
+    #ldap_uri: 'ldap://dc01.foo.com'
+    #ldap_admin: 'CN=Administrator,DC=foo,DC=com'
+    #ldap_passwd: 'your_secret_password'
+    #users_ou: 'OU=Users,DC=foo,DC=com'
 
   roles:
-    - snipeit
+    - snipeit-ansible
 
 ```
+### Install Snipe-IT
+
+    sudo ansible-playbook -i hosts -c local snipeit.yml
+
+
 ### Active Directory User Import
 
 One major feature that is missing from Snipe-IT is Active Directory user import/synchronization. It is important to say that this feature is on the roadmap. But what if you are eager to use Snipe-IT in production and do not want to add each and every user manually? This repository will also deploy simple python script that will import AD users directly into the Snipe-IT database.
 Make sure to modify the last block of the vars section. To import AD users, run `/usr/local/bin/import_ad_users.py`
 
-### Install Snipe-IT
-
-    sudo ansible-playbook -i hosts -c local snipeit.yml
 
 ## Testing Snipe-IT with Vagrant
 
@@ -122,7 +129,7 @@ _Note:_ Currently working and tested on OS X only but should work just fine on L
 
 ```bash
 cd $HOME
-git clone https://github.com/GR360RY/snipeit-ansible.git snipeit-ansible
+git clone https://github.com/GR360RY/snipeit-ansible.git
 cd $HOME/snipeit-ansible
 vagrant up
 ```
diff --git a/meta/main.yml b/meta/main.yml
@@ -1,124 +1,12 @@
 ---
 galaxy_info:
-  author: your name
-  description: 
-  company: your company (optional)
-  # Some suggested licenses:
-  # - BSD (default)
-  # - MIT
-  # - GPLv2
-  # - GPLv3
-  # - Apache
-  # - CC-BY
-  license: license (GPLv2, CC-BY, etc)
-  min_ansible_version: 1.2
-  #
-  # Below are all platforms currently available. Just uncomment
-  # the ones that apply to your role. If you don't see your 
-  # platform on this list, let us know and we'll get it added!
-  #
-  #platforms:
-  #- name: EL
-  #  versions:
-  #  - all
-  #  - 5
-  #  - 6
-  #  - 7
-  #- name: GenericUNIX
-  #  versions:
-  #  - all
-  #  - any
-  #- name: Fedora
-  #  versions:
-  #  - all
-  #  - 16
-  #  - 17
-  #  - 18
-  #  - 19
-  #  - 20
-  #- name: opensuse
-  #  versions:
-  #  - all
-  #  - 12.1
-  #  - 12.2
-  #  - 12.3
-  #  - 13.1
-  #  - 13.2
-  #- name: Amazon
-  #  versions:
-  #  - all
-  #  - 2013.03
-  #  - 2013.09
-  #- name: GenericBSD
-  #  versions:
-  #  - all
-  #  - any
-  #- name: FreeBSD
-  #  versions:
-  #  - all
-  #  - 8.0
-  #  - 8.1
-  #  - 8.2
-  #  - 8.3
-  #  - 8.4
-  #  - 9.0
-  #  - 9.1
-  #  - 9.1
-  #  - 9.2
-  #- name: Ubuntu
-  #  versions:
-  #  - all
-  #  - lucid
-  #  - maverick
-  #  - natty
-  #  - oneiric
-  #  - precise
-  #  - quantal
-  #  - raring
-  #  - saucy
-  #  - trusty
-  #- name: SLES
-  #  versions:
-  #  - all
-  #  - 10SP3
-  #  - 10SP4
-  #  - 11
-  #  - 11SP1
-  #  - 11SP2
-  #  - 11SP3
-  #- name: GenericLinux
-  #  versions:
-  #  - all
-  #  - any
-  #- name: Debian
-  #  versions:
-  #  - all
-  #  - etch
-  #  - lenny
-  #  - squeeze
-  #  - wheezy
-  #
-  # Below are all categories currently available. Just as with
-  # the platforms above, uncomment those that apply to your role.
-  #
-  #categories:
-  #- cloud
-  #- cloud:ec2
-  #- cloud:gce
-  #- cloud:rax
-  #- clustering
-  #- database
-  #- database:nosql
-  #- database:sql
-  #- development
-  #- monitoring
-  #- networking
-  #- packaging
-  #- system
-  #- web
-dependencies: []
-  # List your role dependencies here, one per line. Only
-  # dependencies available via galaxy should be listed here.
-  # Be sure to remove the '[]' above if you add dependencies
-  # to this list.
-  
+  author: Gregory Shulov
+  description: A role for installing Snipe-IT on Debian Based Distros
+  platforms:
+  - name: Ubuntu
+    versions:
+    - trusty
+  categories:
+  - system
+  min_ansible_version: 1.6
+dependencies: []
diff --git a/snipeit.yml b/snipeit.yml
@@ -18,16 +18,16 @@
     admin_email: foo@example.com
     admin_password: bar
 
-    disable_default_apache_site: False
+    disable_default_apache_site: True
     run_mysql_on_all_interfaces: False
 
-    # If you want to import users from Active Directory to Snipe-IT, modify the below values.
+    # If you want to import users from Active Directory to Snipe-IT, uncomment and modify the below values.
     # To import AD users, run /usr/local/bin/import_ad_users.py
 
-    ldap_uri: 'ldap://dc01.foo.com'
-    ldap_admin: 'CN=Administrator,DC=foo,DC=com'
-    ldap_passwd: 'your_secret_password'
-    users_ou: 'OU=Users,DC=foo,DC=com'
+    #ldap_uri: 'ldap://dc01.foo.com'
+    #ldap_admin: 'CN=Administrator,DC=foo,DC=com'
+    #ldap_passwd: 'your_secret_password'
+    #users_ou: 'OU=Users,DC=foo,DC=com'
 
   roles:
     - snipeit-ansible
