Comprehensive Knowledge Archive Network (CKAN) Developer Documentation Release 2.2.3 Open Knowledge Foundation June 14, 2017 Contents 1 Welcome to CKAN’s Documentation1 2 User guide 3 2.1 What is CKAN?.............................................3 2.2 Using CKAN...............................................4 3 Sysadmin guide 17 3.1 Creating a sysadmin account....................................... 17 3.2 Customizing look and feel........................................ 17 3.3 Managing organizations and datasets.................................. 18 3.4 Permanently deleting datasets...................................... 19 3.5 Managing users.............................................. 20 4 Installing CKAN 21 4.1 Installing CKAN from package..................................... 21 4.2 Installing CKAN from source...................................... 23 4.3 Deploying a source install........................................ 28 5 Upgrading CKAN 33 5.1 CKAN releases.............................................. 33 5.2 Release process.............................................. 34 5.3 Upgrading CKAN............................................ 38 6 Getting started 45 6.1 Creating a sysadmin user......................................... 45 6.2 Creating test data............................................. 45 6.3 Config file................................................ 46 7 Features 47 7.1 Command Line Interface......................................... 47 7.2 Organizations and authorization..................................... 54 7.3 Data Viewer............................................... 57 7.4 FileStore and file uploads........................................ 60 7.5 DataStore extension........................................... 62 7.6 Apps & Ideas............................................... 71 7.7 Tag Vocabularies............................................. 71 7.8 Form Integration............................................. 73 7.9 Linked Data and RDF.......................................... 74 7.10 Background tasks............................................. 75 i 7.11 Email notifications............................................ 78 7.12 Page View Tracking........................................... 79 7.13 Multilingual Extension.......................................... 81 7.14 Stats Extension.............................................. 82 8 Writing CKAN extensions 85 8.1 Writing extensions tutorial........................................ 85 8.2 Testing extensions............................................ 94 8.3 Best practices for writing extensions................................... 97 8.4 Plugin interfaces reference........................................ 97 8.5 Plugins toolkit reference......................................... 107 8.6 Converter functions reference...................................... 113 8.7 Validator functions reference....................................... 114 9 Theming 119 9.1 Create Custom Extension........................................ 119 10 The CKAN API 121 10.1 Legacy APIs............................................... 121 10.2 Making an API request.......................................... 129 10.3 Example: Importing datasets with the CKAN API........................... 131 10.4 API versions............................................... 132 10.5 Authentication and API keys....................................... 132 10.6 GET-able API functions......................................... 133 10.7 JSONP support.............................................. 133 10.8 Action API reference........................................... 133 11 Contributing to CKAN 163 11.1 Reporting issues............................................. 163 11.2 Translating CKAN............................................ 163 11.3 Coding standards............................................. 166 11.4 Commit messages............................................ 202 11.5 Frontend development guidelines.................................... 202 11.6 Writing documentation.......................................... 227 11.7 Making a pull request.......................................... 236 12 Testing CKAN 239 12.1 Install additional dependencies...................................... 239 12.2 Set up the test databases......................................... 239 12.3 Run the tests............................................... 239 12.4 Migration testing............................................. 240 12.5 Common error messages......................................... 240 12.6 Front-end Testing............................................. 241 13 Config File Options 243 13.1 General Settings............................................. 243 13.2 Database Settings............................................. 244 13.3 Site Settings............................................... 244 13.4 Authorization Settings.......................................... 246 13.5 Search Settings.............................................. 248 13.6 Plugins Settings............................................. 250 13.7 Front-End Settings............................................ 251 13.8 Theming Settings............................................. 256 13.9 Storage Settings............................................. 257 13.10 DataPusher Settings........................................... 258 ii 13.11 Activity Streams Settings........................................ 259 13.12 Feeds Settings.............................................. 260 13.13 Internationalisation Settings....................................... 260 13.14 Form Settings............................................... 262 13.15 Email Settings.............................................. 262 14 Changelog 265 14.1 v2.2.3 2015-07-22............................................ 265 14.2 v2.2.2 2015-03-04............................................ 265 14.3 v2.2.1 2014-10-15............................................ 266 14.4 v2.2 2014-02-04............................................. 267 14.5 v2.1.5 2015-07-22............................................ 270 14.6 v2.1.4 2015-03-04............................................ 270 14.7 v2.1.3 2014-10-15............................................ 271 14.8 v2.1.2 2014-02-04............................................ 271 14.9 v2.1.1 2013-11-8............................................. 272 14.10 v2.1 2013-08-13............................................. 272 14.11 v2.0.7 2015-07-22............................................ 274 14.12 v2.0.6 2015-03-04............................................ 274 14.13 v2.0.5 2014-10-15............................................ 275 14.14 v2.0.4 2014-02-04............................................ 275 14.15 v2.0.3 2013-11-8............................................. 275 14.16 v2.0.2 2013-08-13............................................ 276 14.17 v2.0.1 2013-06-11............................................ 276 14.18 v2.0 2013-05-10............................................. 276 14.19 v1.8.2 2013-08-13............................................ 279 14.20 v1.8.1 2013-05-10............................................ 279 14.21 v1.8 2012-10-19............................................. 280 14.22 v1.7.4 2013-08-13............................................ 281 14.23 v1.7.3 2013-05-10............................................ 281 14.24 v1.7.2 2012-10-19............................................ 281 14.25 v1.7.1 2012-06-20............................................ 281 14.26 v1.7 2012-05-09............................................. 282 14.27 v1.6 2012-02-24............................................. 283 14.28 v1.5.1 2012-01-04............................................ 284 14.29 v1.5 2011-11-07............................................. 285 14.30 v1.4.3.1 2011-09-30........................................... 286 14.31 v1.4.3 2011-09-13............................................ 286 14.32 v1.4.2 2011-08-05............................................ 287 14.33 v1.4.1 2011-06-27............................................ 288 14.34 v1.4 2011-05-19............................................. 288 14.35 v1.3.3 2011-04-08............................................ 288 14.36 v1.3.2 2011-03-15............................................ 289 14.37 v1.3 2011-02-18............................................. 290 14.38 v1.2 2010-11-25............................................. 290 14.39 v1.1 2010-08-10............................................. 291 14.40 v1.0.2 2010-08-27............................................ 291 14.41 v1.0.1 2010-06-23............................................ 291 14.42 v1.0 2010-05-11............................................. 291 14.43 v0.11 2010-01-25............................................ 292 14.44 v0.10 2009-09-30............................................ 293 14.45 v0.9 2009-07-31............................................. 293 14.46 v0.8 2009-04-10............................................. 294 14.47 v0.7 2008-10-31............................................. 294 iii 14.48 v0.6 2008-07-08............................................. 294 14.49 v0.5 2008-01-22............................................. 294 14.50 v0.4 2007-07-04............................................. 295 14.51 v0.3 2007-04-12............................................. 295 14.52 v0.2 2007-02............................................... 295 14.53 v0.1 2006-05............................................... 295 15 Appendices 297 15.1 Multicore Solr setup..........................................