Merge pull request #982 from holta/elgg-code-cleanup

Elgg code cleanup, in preparation for 3.0.0 later this year?

roles/elgg/README.rst

@@ -6,24 +6,25 @@ Elgg is an award-winning social networking engine, delivering the building block
 that enable businesses, schools, universities and associations to create their own
 fully-featured social networks and applications.
 
-http://elgg.org/
+https://elgg.org
 
 After Installation
 ------------------
 
-Go to http://box.lan/elgg and log on as Admin with password changeme.
+Go to http://box/elgg or http://box.lan/elgg and log on as Admin with password changeme.
 
 Change the following:
 
 * Administrator password
 
-* Title to appear on elgg screens and any other settings as desired.
+* Title to appear on Elgg screens and any other settings as desired.
 
 Locations
 ---------
 
 - The uploaded files are expected to be in /library/elgg
-- The URL is /elgg
+- The software is in /opt/elgg -> /opt/elgg-x.y.z (i.e. actual version number)
+- The URL is http://box/elgg
 
 Parameters
 ----------
@@ -34,16 +35,16 @@ some constraints.
 Users and Passwords
 -------------------
 
-There are a number of seemilingly similar user names and passwords in this installation:
+There are a number of seemingly similar usernames and passwords in this installation:
 
-* dbuser - the mysql user that elgg uses to access the database.  This is a local variable
+* dbuser - the MySQL user that Elgg uses to access the database
-           the name of which corresponds to that in the elgg settings.php file.
+           This is a local variable, the name of which corresponds to that in /opt/elgg/elgg-config/settings.php
 
-* dbpassword - password for dbuser. This is also a local variable
+* dbpassword - password for dbuser
-               the name of which corresponds to that in the elgg settings.php file.
+               This is also a local variable, the name of which corresponds to that in /opt/elgg/elgg-config/settings.php
 
-* elgg_mysql_password - this is the global name for dbpassword in default_vars.yml.
+* elgg_mysql_password - this is the global name for dbpassword in default_vars.yml
 
-* elgg_admin_user - the elgg (not mysql) user that is the administrator.
+* elgg_admin_user - the Elgg (not MySQL) user that is the administrator
 
-* elgg_admin_password - the password for elgg_admin_user.
+* elgg_admin_password - the password for elgg_admin_user

roles/elgg/defaults/main.yml

@@ -7,7 +7,7 @@ elgg_upload_path: /library/elgg
 elgg_install: True
 elgg_enabled: False
 
-# following variables used in elgg engine/settings.php template
+# Variables used by template to create /opt/elgg/elgg-config/settings.php
 dbuser: Admin
 dbpassword: changeme
 dbname: elggdb

roles/elgg/tasks/main.yml

@@ -29,10 +29,9 @@
     state: link
     force: true
 
-# use template to fix up settings in engine/settings.php with our variables substituted
+# Use template to fix up settings in elgg-config/settings.php with our variables substituted.
-# into engine/settings.example.php
+# Note this will overwrite any manual settings.
-# note this will overwrite any manual settings
+- name: Substitute our parameters in /opt/elgg/elgg-config/settings.php
-- name: Substitute our parameters in engine/settings.example.php
   template:
     src: "settings.php.j2"
     dest: "/opt/{{ elgg_xx }}/elgg-config/settings.php"
@@ -90,9 +89,9 @@
     password: "{{ dbpassword }}"
     priv: "{{ dbname }}.*:ALL"
   with_items:
-        - 127.0.0.1
+    - 127.0.0.1
-        - ::1
+    - ::1
-        - localhost
+    - localhost
 
 - name: Create file to load database
   template: