3 # Resource:: mediawiki_site
5 # Copyright:: 2015, OpenStreetMap Foundation
7 # Licensed under the Apache License, Version 2.0 (the "License");
8 # you may not use this file except in compliance with the License.
9 # You may obtain a copy of the License at
11 # https://www.apache.org/licenses/LICENSE-2.0
13 # Unless required by applicable law or agreed to in writing, software
14 # distributed under the License is distributed on an "AS IS" BASIS,
15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 # See the License for the specific language governing permissions and
17 # limitations under the License.
22 default_action :create
24 property :site, :kind_of => String, :name_property => true
25 property :aliases, :kind_of => [String, Array]
26 property :version, :kind_of => String, :default => "1.39"
27 property :database_name, :kind_of => String, :required => true
28 property :database_user, :kind_of => String, :required => [:create, :update]
29 property :database_password, :kind_of => String, :required => [:create, :update]
30 property :sitename, :kind_of => String, :default => "OpenStreetMap Wiki"
31 property :metanamespace, :kind_of => String, :default => "OpenStreetMap"
32 property :logo, :kind_of => String, :default => "$wgStylePath/common/images/wiki.png"
33 property :email_contact, :kind_of => String, :default => ""
34 property :email_sender, :kind_of => String, :default => ""
35 property :email_sender_name, :kind_of => String, :default => "MediaWiki Mail"
36 property :commons, :kind_of => [TrueClass, FalseClass], :default => true
37 property :skin, :kind_of => String, :default => "vector"
38 property :site_notice, :kind_of => [String, TrueClass, FalseClass], :default => false
39 property :site_readonly, :kind_of => [String, TrueClass, FalseClass], :default => false
40 property :admin_user, :kind_of => String, :default => "Admin"
41 property :admin_password, :kind_of => String, :required => [:create]
42 property :private_accounts, :kind_of => [TrueClass, FalseClass], :default => false
43 property :private_site, :kind_of => [TrueClass, FalseClass], :default => false
44 property :hcaptcha_public_key, :kind_of => String, :default => ""
45 property :hcaptcha_private_key, :kind_of => String, :default => ""
46 property :extra_file_extensions, :kind_of => [String, Array], :default => []
47 property :fpm_max_children, :kind_of => Integer, :default => 5
48 property :fpm_start_servers, :kind_of => Integer, :default => 2
49 property :fpm_min_spare_servers, :kind_of => Integer, :default => 1
50 property :fpm_max_spare_servers, :kind_of => Integer, :default => 3
51 property :fpm_request_terminate_timeout, :kind_of => Integer, :default => 300
52 property :fpm_prometheus_port, :kind_of => Integer
53 property :reload_apache, :kind_of => [TrueClass, FalseClass], :default => true
56 node.default[:mediawiki][:sites][new_resource.site] = {
57 :directory => site_directory,
58 :version => new_resource.version
61 mysql_user "#{new_resource.database_user}@localhost" do
62 password new_resource.database_password
66 mysql_database new_resource.database_name do
67 permissions "#{new_resource.database_user}@localhost" => :all
70 mediawiki_directory = "#{site_directory}/w"
72 declare_resource :directory, site_directory do
73 owner node[:mediawiki][:user]
74 group node[:mediawiki][:group]
78 declare_resource :directory, mediawiki_directory do
79 owner node[:mediawiki][:user]
80 group node[:mediawiki][:group]
84 git mediawiki_directory do
86 repository "https://gerrit.wikimedia.org/r/mediawiki/core.git"
87 revision mediawiki_reference
89 user node[:mediawiki][:user]
90 group node[:mediawiki][:group]
93 template "#{mediawiki_directory}/composer.local.json" do
95 source "composer.local.json.erb"
96 owner node[:mediawiki][:user]
97 group node[:mediawiki][:group]
101 execute "#{mediawiki_directory}/composer.json" do
102 command "composer update --no-dev"
103 cwd mediawiki_directory
104 user node[:mediawiki][:user]
105 group node[:mediawiki][:group]
106 environment "COMPOSER_HOME" => site_directory
107 not_if { ::File.exist?("#{mediawiki_directory}/composer.lock") }
110 execute "#{mediawiki_directory}/maintenance/install.php" do
111 # Use metanamespace as Site Name to ensure correct set namespace
112 command "php maintenance/install.php --server '#{name}' --dbtype 'mysql' --dbname '#{new_resource.database_name}' --dbuser '#{new_resource.database_user}' --dbpass '#{new_resource.database_password}' --dbserver 'localhost' --scriptpath /w --pass '#{new_resource.admin_password}' '#{new_resource.metanamespace}' '#{new_resource.admin_user}'"
113 cwd mediawiki_directory
114 user node[:mediawiki][:user]
115 group node[:mediawiki][:group]
116 not_if { ::File.exist?("#{mediawiki_directory}/LocalSettings.php") }
119 declare_resource :directory, "#{mediawiki_directory}/images" do
121 group node[:mediawiki][:group]
125 declare_resource :directory, "#{mediawiki_directory}/cache" do
127 group node[:mediawiki][:group]
131 declare_resource :directory, "#{mediawiki_directory}/LocalSettings.d" do
132 user node[:mediawiki][:user]
133 group node[:mediawiki][:group]
137 template "#{mediawiki_directory}/LocalSettings.php" do
139 source "LocalSettings.php.erb"
140 owner node[:mediawiki][:user]
141 group node[:mediawiki][:group]
143 variables :name => new_resource.site,
144 :directory => mediawiki_directory,
145 :database_params => database_params,
146 :mediawiki => mediawiki_params,
147 :secret_key => secret_key
150 service "mediawiki-sitemap@#{new_resource.site}.timer" do
151 action [:enable, :start]
152 only_if { ::File.exist?("#{mediawiki_directory}/LocalSettings.php") }
155 service "mediawiki-jobs@#{new_resource.site}.timer" do
156 action [:enable, :start]
157 only_if { ::File.exist?("#{mediawiki_directory}/LocalSettings.php") }
160 service "mediawiki-email-jobs@#{new_resource.site}.timer" do
161 action [:enable, :start]
162 only_if { ::File.exist?("#{mediawiki_directory}/LocalSettings.php") }
165 service "mediawiki-refresh-links@#{new_resource.site}.timer" do
166 action [:disable, :stop]
169 template "/etc/cron.daily/mediawiki-#{cron_name}-backup" do
171 source "mediawiki-backup.cron.erb"
175 variables :name => new_resource.site,
176 :directory => site_directory,
177 :database_params => database_params
178 only_if { ::File.exist?("#{mediawiki_directory}/LocalSettings.php") }
181 # MobileFrontend extension is required by MinervaNeue skin
182 mediawiki_extension "MobileFrontend" do
183 site new_resource.site
184 template "mw-ext-MobileFrontend.inc.php.erb"
188 # MobileFrontend extension is required by MinervaNeue skin
189 mediawiki_skin "MinervaNeue" do
190 site new_resource.site
195 mediawiki_skin "CologneBlue" do
196 site new_resource.site
201 mediawiki_skin "Modern" do
202 site new_resource.site
207 mediawiki_skin "MonoBook" do
208 site new_resource.site
213 mediawiki_skin "Vector" do
214 site new_resource.site
219 mediawiki_extension "Cite" do
220 site new_resource.site
224 mediawiki_extension "CiteThisPage" do
225 site new_resource.site
229 if new_resource.private_accounts || new_resource.private_site
230 mediawiki_extension "ConfirmEdit" do
231 site new_resource.site
236 mediawiki_extension "ConfirmEdit" do
237 site new_resource.site
238 template "mw-ext-ConfirmEdit.inc.php.erb"
239 variables :public_key => new_resource.hcaptcha_public_key,
240 :private_key => new_resource.hcaptcha_private_key
245 mediawiki_extension "Gadgets" do
246 site new_resource.site
250 mediawiki_extension "ImageMap" do
251 site new_resource.site
255 mediawiki_extension "InputBox" do
256 site new_resource.site
260 mediawiki_extension "Interwiki" do
261 site new_resource.site
262 template "mw-ext-Interwiki.inc.php.erb"
266 mediawiki_extension "Nuke" do
267 site new_resource.site
271 mediawiki_extension "ParserFunctions" do
272 site new_resource.site
273 template "mw-ext-ParserFunctions.inc.php.erb"
277 mediawiki_extension "PdfHandler" do
278 site new_resource.site
279 template "mw-ext-PdfHandler.inc.php.erb"
283 mediawiki_extension "Poem" do
284 site new_resource.site
288 mediawiki_extension "Renameuser" do
289 site new_resource.site
293 mediawiki_extension "SimpleAntiSpam" do
294 site new_resource.site
299 mediawiki_extension "SpamBlacklist" do
300 site new_resource.site
301 template "mw-ext-SpamBlacklist.inc.php.erb"
305 mediawiki_extension "SyntaxHighlight_GeSHi" do
306 site new_resource.site
307 template "mw-ext-SyntaxHighlight.inc.php.erb"
311 mediawiki_extension "TitleBlacklist" do
312 site new_resource.site
313 template "mw-ext-TitleBlacklist.inc.php.erb"
317 mediawiki_extension "WikiEditor" do
318 site new_resource.site
322 mediawiki_extension "Babel" do
323 site new_resource.site
324 template "mw-ext-Babel.inc.php.erb"
328 mediawiki_extension "CategoryTree" do
329 site new_resource.site
333 mediawiki_extension "cldr" do
334 site new_resource.site
335 template "mw-ext-cldr.inc.php.erb"
339 mediawiki_extension "CleanChanges" do
340 site new_resource.site
341 template "mw-ext-CleanChanges.inc.php.erb"
345 mediawiki_extension "LocalisationUpdate" do
346 site new_resource.site
347 template "mw-ext-LocalisationUpdate.inc.php.erb"
351 # mediawiki_extension "Translate" do
352 # site new_resource.site
353 # template "mw-ext-Translate.inc.php.erb"
357 mediawiki_extension "UniversalLanguageSelector" do
358 site new_resource.site
359 template "mw-ext-UniversalLanguageSelector.inc.php.erb"
363 mediawiki_extension "AntiSpoof" do
364 site new_resource.site
365 template "mw-ext-AntiSpoof.inc.php.erb"
369 mediawiki_extension "AbuseFilter" do
370 site new_resource.site
371 template "mw-ext-AbuseFilter.inc.php.erb"
375 mediawiki_extension "CheckUser" do
376 site new_resource.site
377 template "mw-ext-CheckUser.inc.php.erb"
381 mediawiki_extension "DismissableSiteNotice" do
382 site new_resource.site
386 mediawiki_extension "Elastica" do
387 site new_resource.site
391 mediawiki_extension "CirrusSearch" do
392 site new_resource.site
393 template "mw-ext-CirrusSearch.inc.php.erb"
397 mediawiki_extension "osmtaginfo" do
398 site new_resource.site
399 repository "https://github.com/openstreetmap/osmtaginfo.git"
404 mediawiki_extension "OSMCALWikiWidget" do
405 site new_resource.site
406 repository "https://github.com/thomersch/OSMCALWikiWidget.git"
411 mediawiki_extension "DisableAccount" do
412 site new_resource.site
413 template "mw-ext-DisableAccount.inc.php.erb"
417 mediawiki_extension "VisualEditor" do
418 site new_resource.site
419 template "mw-ext-VisualEditor.inc.php.erb"
420 variables :version => new_resource.version
424 mediawiki_extension "TemplateData" do
425 site new_resource.site
429 if new_resource.commons
430 mediawiki_extension "QuickInstantCommons" do
431 site new_resource.site
435 mediawiki_extension "QuickInstantCommons" do
436 site new_resource.site
442 cookbook_file "#{site_directory}/cc-wiki.png" do
444 owner node[:mediawiki][:user]
445 group node[:mediawiki][:group]
450 cookbook_file "#{site_directory}/googled06a989d1ccc8364.html" do
452 owner node[:mediawiki][:user]
453 group node[:mediawiki][:group]
458 cookbook_file "#{site_directory}/googlefac54c35e800caab.html" do
460 owner node[:mediawiki][:user]
461 group node[:mediawiki][:group]
466 ssl_certificate new_resource.site do
467 domains [new_resource.site] + Array(new_resource.aliases)
470 php_fpm new_resource.site do
471 pm_max_children new_resource.fpm_max_children
472 pm_start_servers new_resource.fpm_start_servers
473 pm_min_spare_servers new_resource.fpm_min_spare_servers
474 pm_max_spare_servers new_resource.fpm_max_spare_servers
475 request_terminate_timeout new_resource.fpm_request_terminate_timeout
476 php_admin_values "open_basedir" => "#{site_directory}/:/usr/share/php/:/dev/null:/tmp/"
477 php_values "memory_limit" => "500M",
478 "max_execution_time" => "240",
479 "upload_max_filesize" => "70M",
480 "post_max_size" => "100M"
481 prometheus_port new_resource.fpm_prometheus_port
484 apache_site new_resource.site do
486 template "apache.erb"
487 directory site_directory
488 variables :aliases => Array(new_resource.aliases),
489 :private_site => new_resource.private_site
493 # FIXME: needs to run one
494 execute "#{mediawiki_directory}/extensions/CirrusSearch/maintenance/updateSearchIndexConfig.php" do
496 command "php extensions/CirrusSearch/maintenance/updateSearchIndexConfig.php"
497 cwd mediawiki_directory
498 user node[:mediawiki][:user]
499 group node[:mediawiki][:group]
504 mediawiki_directory = "#{site_directory}/w"
506 execute "#{mediawiki_directory}/composer.json" do
507 command "composer update --no-dev"
508 cwd mediawiki_directory
509 user node[:mediawiki][:user]
510 group node[:mediawiki][:group]
511 environment "COMPOSER_HOME" => site_directory
514 template "#{mediawiki_directory}/LocalSettings.php" do
516 source "LocalSettings.php.erb"
517 owner node[:mediawiki][:user]
518 group node[:mediawiki][:group]
520 variables :name => new_resource.site,
521 :directory => mediawiki_directory,
522 :database_params => database_params,
523 :mediawiki => mediawiki_params,
524 :secret_key => secret_key
527 execute "#{mediawiki_directory}/maintenance/update.php" do
529 command "php maintenance/update.php --quick"
530 cwd mediawiki_directory
531 user node[:mediawiki][:user]
532 group node[:mediawiki][:group]
538 apache_site new_resource.site do
543 declare_resource :directory, site_directory do
548 mysql_database new_resource.database_name do
552 mysql_user "#{new_resource.database_user}@localhost" do
558 include OpenStreetMap::Mixin::PersistentToken
561 "/srv/#{new_resource.site}"
564 def mediawiki_reference
565 shell_out!("git", "ls-remote", "--refs", "--sort=-version:refname",
566 "https://gerrit.wikimedia.org/r/mediawiki/core.git",
567 "refs/tags/#{new_resource.version}.*")
576 new_resource.site.tr(".", "_")
581 :host => "localhost",
582 :name => new_resource.database_name,
583 :username => new_resource.database_user,
584 :password => new_resource.database_password
590 :sitename => new_resource.sitename,
591 :metanamespace => new_resource.metanamespace,
592 :logo => new_resource.logo,
593 :email_contact => new_resource.email_contact,
594 :email_sender => new_resource.email_sender,
595 :email_sender_name => new_resource.email_sender_name,
596 :commons => new_resource.commons,
597 :skin => new_resource.skin,
598 :site_notice => new_resource.site_notice,
599 :site_readonly => new_resource.site_readonly,
600 :extra_file_extensions => new_resource.extra_file_extensions,
601 :private_accounts => new_resource.private_accounts,
602 :private_site => new_resource.private_site
607 persistent_token("mediawiki", new_resource.site, "wgSecretKey")
612 notifies :update, "mediawiki_site[#{site}]"
613 notifies :reload, "service[apache2]" if reload_apache