/
UPGRADE
244 lines (178 loc) · 12.6 KB
/
UPGRADE
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
==
= Upgrading From Kete 1.0 to Kete 1.1 =
==
For detailed instructions on upgrading from Kete 1.0 to Kete 1.1, please refer to
the online documentation at
http://kete.net.nz/documentation/topics/show/177-upgrading-to-kete-11-release
You can safely ignore everything below here if you follow the online topic.
==
= Incremental Upgrade Instructions
==
Originally contributed by James Stradling <james@katipo.co.nz> - 2008-05-16
The following steps are only necessary if you continuously upgrade your code base to the latest Kete trunk.
Occasionally there are additional minor steps needed to update your Kete installation between revisions.
You can find these by scrolling down to the time where you last updated Kete, and going up through the additional steps.
GENERAL NOTE: If you have a lot of things to do, you could alternatively follow the upgrade guide mentioned above, which is
essentially a collection of all the commands used below into one step by step guide.
GENERAL NOTE: It is assumed you are upgrading from an earlier functional and unmodified trunk version. If not, be sure to preserve
the customizations you want to keep when you upgrade the code base.
GENERAL NOTE: Quite often you'll only have to do steps once to get the changes from multiple revisions. In other words,
if a step is listed from multiple revisions, you only have to do it once.
IMPORTANT NOTE: For any steps where you run, "rake db:migrate", it is a good idea to back up your database before you run that step.
GENERAL NOTE: if you are upgrading your production Kete instance rather than development, you'll add "RAILS_ENV=production" to all rake tasks.
GENERAL NOTE: if you are running in production mode, you may also want to do a "rake tmp:cache:clear" as your last step to any of these.
However, if you updated your code via a Capistrano deploy, this is probably not necessary.
== 2008/10/01 - Private files need to be copied to system folder
Due to a missing configuration in the Capistrano deployment recipes, private files were archived every time the site was deploy.
A fix has been committed which resolves the problem for future deployments. But you need to manually copy the old private files
from the releases/[timestamp]/private directory to the new system folder at shared/system/private
== 2008/09/26 - Backgroundrb configuration yml file updated
1. Stop your Backgroundrb processes
2. Update packet by running
sudo gem update packet
3. Open up background.yml and add the following line to the :backgroundrb: section and save
:persistent_disabled: true
2. Start your Backgroundrb processes
== 2008/09/17 - CSS "tags" Identifier Changed
To fix an IE6 specific printing bug, the CSS identifier "tags" has been changed to "tags-box". If you are running Kete with a custom theme, be sure to update your theme templates and CSS files to refer to the new "tags-box" CSS identifier, and not the older "tags".
The default Kete template has already been updated.
Once this has been completed, you may need to update and restart your Kete based website to effect the changes.
Complete steps are:
1. Update all references to the "tags" CSS identifier in custom template(s) as mentioned below:
a) id="tags" should be changed to id="tags-box" in HTML templates
b) #tags should be changed to #tags-box in CSS templates
The default Kete templates have already been updated.
2. Run tmp:cache:clear (not necessary for capistrano deployments)
3. Restart your Kete server
== 2008/08/07 - Fixing Caching Issues
1. Stop your Kete server (mongrels, backgroundrb).
2. Upgrade your code base
3. rake tmp:cache:clear (not necessary for capistrano deployments)
4. Start your Kete server again (mongrels, backgroundrb)
== 2008/08/01 - Making search for contributions by a user be limited to login, rather than non-unique user name
1. Stop your Kete server (mongrels).
2. Upgrade your code base
3. Start your Kete server again (mongrels)
4. Rebuild your search records (see other tasks below for summary under "Use the web interface to repopulate your Zebra database...")
== 2008/08/01 - Adding system setting for Syntax Highlighting support
1. Stop your Kete server (mongrels).
2. Upgrade your code base
4. Run the upgrade script: 'rake kete:upgrade'
5. Start your Kete server again (mongrels)
== 2008/07/18 - Upgrading backgroundrb and packet gem
1. Upgrade your code base
2. Down/Upgrade to packet 0.1.7 (the next version is buggy). You can skip this step if you already have packet 0.1.7 installed.
$ gem uninstall packet --all
$ gem install packet --version 0.1.7
3. Edit config/backgroundrb.yml and update it to match the structure of config/backgroundrb.yml.example. Point the :memcached: section to the appropriate IP of the memcached server (default should usually suffice).
4. Run the database migration 'rake db:migrate'
5. Restart your Kete instance (mongrels)
6. Restart your Backgroundrb instance:
./script/backgroundrb stop
./script/backgroundrb start
== Trunk r1324 - support for basket list navigation in a left column, experimental
1. Stop your Kete server (mongrels).
2. Upgrade your code base
4. Run the upgrade script: 'rake kete:upgrade'
5. Start your Kete server again (mongrels)
== Trunk r1322 - ticket #206 simple bulk import of related items
1. Stop your Kete server (mongrels, backgroundrb).
2. Upgrade your code base
3. Run the database migration 'rake db:migrate'
4. Run the upgrade script: 'rake kete:upgrade'
5. Start your Kete server again (mongrels, backgroundrb)
== Trunk r1304 - Removal of foreign key constraint causing topic + related item deletion failure.
1. Upgrade your code base
2. Run the database migration 'rake db:migrate'
3. Restart your Kete instance (mongrels)
== Trunk r1254 - Adding OAI-PMH Repository functionality and significant refactoring of search. This is a big one if you have lots of items in Kete.
1. Upgrade your code base
2. Run the database migration 'rake db:migrate'
3. Stop your Kete instance (mongrels)
Next, You'll need to rebuild your Zebra indexes to have dates sort without error. Here's how:
4. Run this script to clear your public Zebra database: 'rake zebra:init'
5. Run this script to clear your private Zebra database: 'rake zebra:init ZEBRA_DB=private'
6. Run this script to stop your Zebra server: 'rake zebra:stop'
7. Run this script to start your Zebra server: 'rake zebra:start'
8. Run the kete upgrade steps with 'rake kete:upgrade'
8. Start your Kete server again (mongrels, backgroundrb)
9. Use the web interface to repopulate your Zebra databases with these steps:
* make sure you are logged into the site as as the default administrator or an account that has been designated as a "tech admin" and have javascript enabled in your browser.
* visit the following URLs (adjust for your site's URL) and let them click over (ajax update of page) until you get a "done"
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=StillImage
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=AudioRecording
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=Video
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=WebLink
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=Document
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=Comment
* then double check that search results are good to go by clicking on "Browse" from any page or doing a search
== Trunk r1251 - Workaround for 'svn up' issue regarding public/javascripts and vendor/plugins/acts_as_licensed
1. Remove the folder public/javascripts
2. Remove the folder vendor/plugins/acts_as_licensed
3. Upgrade your code base
4. Restart your Kete instance (mongrels)
== Trunk r1237 - Bug fixes for tagging on private item versions.
1. Upgrade your code base
2. Run the database migration 'rake db:migrate'
3. Restart your Kete instance (mongrels)
== Trunk r1235 - Added system setting for the placeholder details used on public versions of items when no public version is available.
1. Upgrade your code base
2. Run the upgrade rake task 'rake kete:upgrade'
3. Restart your Kete instance (mongrels)
== Trunk r1225 - MySQL only, change column definitions to allow for larger amount of text
1. Upgrade your code base
2. Run the migrate rake task 'rake db:migrate'
== Trunk r1196 - Added HTTPS/SSL support
To update from r1196 or later, follow these instructions:
1. Stop your Kete server (mongrels, backgroundrb).
2. Upgrade your code base
3. Run the kete upgrade rake task 'rake kete:upgrade'
4. Start your Kete server again (mongrels, backgroundrb)
Note: You must have a web server and SSL certificate correctly configured
in order to take advantage of SSL features in this version. The SSL features are
disabled by default and can be enabled in the Server advanced settings in the
configuration assistant/reconfigure site controls.
== Trunk r1174 - Added per basket privacy control enable/disable preferences
To update from r1169 through r1173, all you need to do is the following:
1. Stop your Kete server (mongrels, backgroundrb).
2. Upgrade your code base
3. Run the database migration 'rake db:migrate'
4. Start your Kete server again (mongrels, backgroundrb)
If you are updating from an earlier version, please following the instructions for trunk r1169 below.
== Trunk r1169 - Content Licensing Controls Added
This version includes content licensing controls in addition to the privacy control functionality added in r1148.
The following instructions are for use when updating from a trunk version of Kete to a version r1169 or later.
NB: All commands must be made from the main Kete application directory.
1. Stop your Kete server (mongrels, backgroundrb).
2. Upgrade your code base
3. Run the database migration 'rake db:migrate'
NB: This adds new columns and tables in the kete database. If you have customized Kete or
need to reverse the upgrade, this may cause issues. See migrations 046 through 060 in
/db/migrate/ for an insight into the database schema changes made.
4. Run the upgrade script: 'rake kete:upgrade'
5. Start your Kete server again (mongrels, backgroundrb)
Optionally, you can run rake acts_as_licensed:import_nz_cc_licenses to
add Creative Commons New Zealand licenses options to your Kete
instance. After that, you probably want to reconfigure your site in
Advanced Options > Server > Default Content License.
== Trunk r1107 - Search and Browse results sorting
You'll need to rebuild your Zebra indexes to have dates sort without error. Here's how:
1. Stop your Kete server (mongrels, backgroundrb).
2. Upgrade your code base
3. Run this script to clear your public Zebra database: 'rake zebra:init'
4. Run this script to clear your private Zebra database: 'rake zebra:init ZEBRA_DB=private'
5. Run this script to stop your Zebra server: 'rake zebra:stop'
6. Run this script to start your Zebra server: 'rake zebra:start'
7. Start your Kete server again (mongrels, backgroundrb)
8. Use the web interface to repopulate your Zebra databases with these steps:
* make sure you are logged into the site as as the default administrator or an account that has been designated as a "tech admin" and have javascript enabled in your browser.
* visit the following URLs (adjust for your site's URL) and let them click over (ajax update of page) until you get a "done"
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=StillImage
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=AudioRecording
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=Video
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=WebLink
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=Document
your_site_domain/site/search/rebuild_zoom_index?skip_existing=false&zoom_class=Comment
* then double check that search results are good to go by clicking on "Browse" from any page or doing a search