README 5.47 KB
Newer Older
Eric Rasmussen's avatar
test    
Eric Rasmussen committed
1
2
3
********
** How to set up UNL_Elgg:
********
4
5
Run the setup.sh script to symlink all the necessary plugins
	./setup.sh
Eric Rasmussen's avatar
Eric Rasmussen committed
6
Create a mysql database named unl_social
7
Import the full_dump.sql file*
8
	mysql -u root unl_social < full_dump.sql
Eric Rasmussen's avatar
Eric Rasmussen committed
9
10
Browse to the elgg directory in your web browser and do elgg's installation:
	Create the local elgg/.htaccess file using the sample on the install page
11
		Be sure to set the correct RewriteBase /workspace/UNL_Elgg/elgg/ for example.
Eric Rasmussen's avatar
Eric Rasmussen committed
12
13
	Create the local elgg/engine/settings.php file.
		Be sure to specify unl_social as the database name
14
15
		Add this settings file to your svn:ignore list
Create a local directory named elgg_data for elgg to write to outside of the web root.
16
17
	Change the permissions so Apache has write access to it.
	sudo chown _www elgg_data
Eric Rasmussen's avatar
Eric Rasmussen committed
18
19
20
21
Install pear http://pear.php.net/manual/en/installation.getting.php
	Install the UNL_Templates pear packages
		pear channel-discover pear.unl.edu && pear install unl/UNL_Templates-beta unl/UNL_Services_Peoplefinder-beta DB
Set the correct site url within the unl_social database:
22
23
24
	UPDATE elggsites_entity SET url='http://ucommbieber.unl.edu/workspace/UNL_Elgg/elgg/' WHERE guid=1;
	UPDATE elggdatalists SET value = '/Users/bbieber/Documents/workspace/UNL_Elgg/elgg/' WHERE name = 'path';
	UPDATE elggdatalists SET value = '/Users/bbieber/Documents/workspace/UNL_Elgg/elgg_data/' WHERE name = 'dataroot';
Eric Rasmussen's avatar
Eric Rasmussen committed
25
26
27
28
29
30
31
32
33
34
Make sure the local site has an updated copy of the unl templatedependents

******
** Troubleshooting
******
After navigating to the elgg dir in your browser and filling in the correct database info - 
if you get the error that elgg can't connect to your database do this:
1. find your php.ini file, probably located at /etc/php.ini.default and rename it to php.ini
2. edit the mysql.default_socket line to include the path to your mysql.sock file, e.g.
   mysql.default_socket = /private/tmp/mysql.sock
35

Eric Rasmussen's avatar
test    
Eric Rasmussen committed
36
 
37

Eric Rasmussen's avatar
test    
Eric Rasmussen committed
38
39
40
*******
** Notes on importing data:
*******
Matthew Juhl's avatar
Matthew Juhl committed
41
42
43
44

****From here on out we will be dumping data from the live server to import on testing instances only. Changes on test
instances that modify database fields must be documented and repeated on the live server after testing.

45
46
47
48
49
full_dump.sql is is full copy of the mysql database that must be modified upon import.
safe_dump.sql can be imported without the need for modification

when importing full_dump.sql, you must modify certain rows in the tables elggdatalists and elggsites_entity so
that they pertain to the local elgg site instance. 	(so if you see something like 
Eric Rasmussen's avatar
test    
Eric Rasmussen committed
50
51
http://ucommjuhl.unl.edu/UNL_Elgg/elgg, change it!)

52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
*******
** Notes on importing data for dev to local machine:
*******
-ftp a copy of the database to your machine
    scp unl_social_2010-04-22_00h10m.Thursday.sql usernameonlocalmachine@yourmachine.com:/Path/To/Transer/To
-import it
    mysql -u username -p < /Path/To/unl_social_2010-04-22_00h10m.Thursday.sql
-Set the correct site url within the unl_social database:
    mysql -u username -p
    use unl_social;
    UPDATE elggsites_entity SET url='http://ucommbieber.unl.edu/workspace/UNL_Elgg/elgg/' WHERE guid=1;
    UPDATE elggdatalists SET value = '/Users/bbieber/Documents/workspace/UNL_Elgg/elgg/' WHERE name = 'path';
    UPDATE elggdatalists SET value = '/Users/bbieber/Documents/workspace/UNL_Elgg/elgg_data/' WHERE name = 'dataroot';
-zip up elgg_data and ftp that
    zip -r newfilename elgg_data
-replace your local copy of elgg_data with this one and make sure apache (could be _www or apache or ?) has write access to it
    cd path/to/elgg_data
    sudo chown -R _www *
    
Eric Rasmussen's avatar
test    
Eric Rasmussen committed
71
72


73
74
75
*******
** Plugin info
*******
76
Just run the setup.sh script. If any plugins are added, add this to the setup.sh script.
Eric Rasmussen's avatar
Eric Rasmussen committed
77
78

elgg https://code.elgg.org/elgg/trunk/
79

Eric Rasmussen's avatar
Eric Rasmussen committed
80
81
82
83
84
elgg/mod/groups https://code.elgg.org/extensions/plugins/groups
elgg/mod/notifications https://code.elgg.org/extensions/plugins/notifications
elgg/mod/profile https://code.elgg.org/extensions/plugins/profile
elgg/mod/reportedcontent https://code.elgg.org/extensions/plugins/reportedcontent
elgg/mod/riverdashboard https://code.elgg.org/extensions/plugins/riverdashboard
85
86
elgg/mod/thewire https://code.elgg.org/extensions/plugins/thewire

Eric Rasmussen's avatar
Eric Rasmussen committed
87
elgg/mod/flexprofile http://its-gforge.unl.edu/svn/unl_elgg/trunk/flexprofile_mj
88
89
90
91
92
elgg/mod/form        http://its-gforge.unl.edu/svn/unl_elgg/trunk/plugins/form
elgg/mod/globe 	http://its-gforge.unl.edu/svn/unl_elgg/trunk/plugins/globe
elgg/mod/messages	http://its-gforge.unl.edu/svn/unl_elgg/trunk/plugins/messages
elgg/mod/browse	http://its-gforge.unl.edu/svn/unl_elgg/trunk/plugins/browse
elgg/mod/mass_mailouts	http://its-gforge.unl.edu/svn/unl_elgg/trunk/plugins/mass_mailouts
93
elgg/mod/cas_auth_unl	http://its-gforge.unl.edu/svn/unl_elgg/trunk/plugins/cas_auth_unl
94
95
elgg/mod/customindex	http://its-gforge.unl.edu/svn/unl_elgg/trunk/plugins/customindex
elgg/mod/unl_theme	http://its-gforge.unl.edu/svn/unl_elgg/trunk/plugins/unl_theme 
96

Eric Rasmussen's avatar
Eric Rasmussen committed
97
elgg/featured/ http://its-gforge.unl.edu/svn/unl_huskers/trunk/
Seth Meranda's avatar
Seth Meranda committed
98
99
100
101
102

*******
** Patches
*******
All patches are located in the /pathces directory. These include:
103
104
105
106
patches/relationship_get_set_public.diff  *__get __set not declared correctly
patches/lowercase_post.diff           *Forms use POST which doesn't validate 
patches/strip_tags_name_field.diff	  *Display Name field allowed html that often was not escaped upon output
patches/add_closing_labels.diff       
Seth Meranda's avatar
Seth Meranda committed
107

108
109
110
111
112
113

*******
** Things to look out for when new versions of Elgg are released
*******
-- Are there changes to /elgg/actions/login.php and /elgg/actions/logout.php ?????
	We have overridden those actions with our own in the cas_auth_unl plugin