Full table of contents¶
- User guide
- Sysadmin guide
- Maintainer’s guide
- Installing CKAN
- Installing CKAN from package
- Installing CKAN from source
- Deploying a source install
- 1. Create a
production.ini
File - 2. Install Apache, modwsgi, modrpaf
- 3. Install Nginx
- 4. Install an email server
- 5. Create the WSGI script file
- 6. Create the Apache config file
- 7. Modify the Apache ports.conf file
- 8. Create the Nginx config file
- 9. Enable your CKAN site
- 10. Setup a worker for background jobs
- Troubleshooting
- 1. Create a
- Upgrading CKAN
- CKAN releases
- Upgrading CKAN
- Getting started
- Database Management
- Command Line Interface
- Troubleshooting Paster Commands
- Paster Commands Reference
- check-po-files: Check po files for common mistakes
- color: Create or remove a color scheme
- create-test-data: Create test data
- dataset: Manage datasets
- datastore: Perform commands to set up the datastore
- db: Manage databases
- front-end-build: Creates and minifies css and JavaScript files
- jobs: Manage background jobs
- less: Compile all root less documents into their CSS counterparts
- minify: Create minified versions of the given Javascript and CSS files
- notify: Send out modification notifications
- plugin-info: Provide info on installed plugins
- profile: Code speed profiler
- ratings: Manage dataset ratings
- rdf-export: Export datasets as RDF
- search-index: Rebuild search index
- sysadmin: Give sysadmin rights
- tracking: Update tracking statistics
- trans: Translation helper functions
- user: Create and manage users
- Organizations and authorization
- Organizations
- Configuration File Options
- ckan.auth.anon_create_dataset
- ckan.auth.create_unowned_dataset
- ckan.auth.create_dataset_if_not_in_organization
- ckan.auth.user_create_groups
- ckan.auth.user_create_organizations
- ckan.auth.user_delete_groups
- ckan.auth.user_delete_organizations
- ckan.auth.create_user_via_api
- ckan.auth.create_user_via_web
- ckan.auth.roles_that_cascade_to_sub_groups
- Extensions
- Data preview and visualization
- FileStore and file uploads
- DataStore extension
- Apps & Ideas
- Tag Vocabularies
- Form Integration
- Linked Data and RDF
- Background jobs
- Email notifications
- Page View Tracking
- Multilingual Extension
- Stats Extension
- Configuration Options
- Environment variables
- Updating configuration options during runtime
- CKAN configuration file
- General Settings
- Repoze.who Settings
- Database Settings
- Site Settings
- Authorization Settings
- ckan.auth.anon_create_dataset
- ckan.auth.create_unowned_dataset
- ckan.auth.create_dataset_if_not_in_organization
- ckan.auth.user_create_groups
- ckan.auth.user_create_organizations
- ckan.auth.user_delete_groups
- ckan.auth.user_delete_organizations
- ckan.auth.create_user_via_api
- ckan.auth.create_user_via_web
- ckan.auth.roles_that_cascade_to_sub_groups
- Search Settings
- Redis Settings
- CORS Settings
- Plugins Settings
- Front-End Settings
- ckan.site_title
- ckan.site_description
- ckan.site_intro_text
- ckan.site_logo
- ckan.site_about
- ckan.main_css
- ckan.favicon
- ckan.legacy_templates
- ckan.datasets_per_page
- package_hide_extras
- ckan.dumps_url
- ckan.dumps_format
- ckan.recaptcha.version
- ckan.recaptcha.publickey
- ckan.recaptcha.privatekey
- ckan.featured_groups
- ckan.featured_orgs
- ckan.gravatar_default
- ckan.debug_supress_header
- Resource Views Settings
- Theming Settings
- Storage Settings
- DataPusher Settings
- User Settings
- Activity Streams Settings
- Feeds Settings
- Internationalisation Settings
- Form Settings
- Email Settings
- Installing CKAN
- API guide
- Extending guide
- Writing extensions tutorial
- Using custom config settings in extensions
- Making configuration options runtime-editable
- Testing extensions
- Best practices for writing extensions
- Follow CKAN’s coding standards
- Use the plugins toolkit instead of importing CKAN
- Don’t edit CKAN’s database tables
- Implement each plugin class in a separate Python module
- Avoid name clashes
- Internationalize user-visible strings
- Add third party libraries to requirements.txt
- Do not automatically modify the database structure
- Customizing dataset and resource metadata fields using IDatasetForm
- Plugin interfaces reference
- Plugins toolkit reference
- Validator functions reference
- Internationalizing strings in extensions
- Theming guide
- Customizing CKAN’s templates
- Creating a CKAN extension
- Replacing a default template file
- Jinja2
- Extending templates with
{% ckan_extends %}
- Replacing template blocks with
{% block %}
- Extending parent blocks with Jinja’s
{{ super() }}
- Template helper functions
- Adding your own template helper functions
- Template snippets
- Adding your own template snippets
- HTML tags and CSS classes
- Accessing custom config settings from templates
- Adding static files
- Customizing CKAN’s CSS
- Adding CSS and JavaScript files using Fanstatic
- Customizing CKAN’s JavaScript
- Best practices for writing CKAN themes
- Custom Jinja2 tags reference
- Variables and functions available to templates
- Objects and methods available to JavaScript modules
- Template helper functions reference
- Template snippets reference
- JavaScript sandbox reference
- JavaScript API client reference
- CKAN jQuery plugins reference
- Customizing CKAN’s templates
- Contributing guide
- Reporting issues
- Translating CKAN
- Testing CKAN
- Writing commit messages
- Making a pull request
- Reviewing and merging a pull request
- Writing documentation
- Projects for beginner CKAN developers
- CKAN code architecture
- CSS coding standards
- HTML coding standards
- JavaScript coding standards
- Python coding standards
- String internationalization
- Unicode handling
- Testing coding standards
- Transitioning from legacy to new tests
- Guidelines for writing new-style tests
- How should tests be organized?
- Recipe for a test method
- How detailed should tests be?
- Creating test objects:
ckan.tests.factories
- Test helper functions:
ckan.tests.helpers
- Mocking: the
mock
library - Writing
ckan.logic.action
tests - Writing
ckan.logic.auth
tests - Writing converter and validator tests
- No tests for
ckan.logic.schema.py
- Writing
ckan.controllers
tests - Writing
ckan.model
tests - Writing
ckan.lib
tests - Writing
ckan.plugins
tests - Writing
ckan.migration
tests - Writing
ckan.ckanext
tests
- Creating test objects:
- Frontend development guidelines
- Templating
- Resources
- Creating a new template
- Template Blocks
- Blocks in page.html
- Blocks in base.html
- Building a JavaScript Module
- Install frontend dependencies
- File structure
- Stylesheets
- JavaScript
- Database migrations
- Upgrading CKAN’s dependencies
- Doing a CKAN release
- Changelog
- v.2.7.12 2021-09-22
- v.2.7.11 2021-05-19
- v.2.7.10 2021-02-10
- v.2.7.9 2020-10-21
- v.2.7.8 2020-08-05
- v.2.7.7 2020-04-15
- v.2.7.6 2019-07-03
- v2.7.5 2018-12-12
- v2.7.4 2018-05-09
- v2.7.3 2018-03-15
- v2.7.2 2017-09-28
- v2.7.1 2017-09-27
- v2.7.0 2017-08-02
- v2.6.7 2018-12-12
- v2.6.6 2018-05-09
- v2.6.5 2018-03-15
- v2.6.4 2017-09-27
- v2.6.3 2017-08-02
- v2.6.2 2017-03-22
- v2.6.1 2017-02-22
- v2.6.0 2016-11-02
- v2.5.4 2017-02-22
- v2.5.3 2016-11-02
- v2.5.2 2016-03-31
- v2.5.1 2015-12-17
- v2.5.0 2015-12-17
- v2.4.6 2017-02-22
- v2.4.5 2017-02-22
- v2.4.4 2016-11-02
- v2.4.3 2016-03-31
- v2.4.2 2015-12-17
- v2.4.1 2015-09-02
- v2.4.0 2015-07-22
- v2.3.5 2016-11-02
- v2.3.4 2016-03-31
- v2.3.3 2015-12-17
- v2.3.2 2015-09-02
- v2.3.1 2015-07-22
- v2.3 2015-03-04
- v2.2.4 2015-12-17
- v2.2.3 2015-07-22
- v2.2.2 2015-03-04
- v2.2.1 2014-10-15
- v2.2 2014-02-04
- v2.1.6 2015-12-17
- v2.1.5 2015-07-22
- v2.1.4 2015-03-04
- v2.1.3 2014-10-15
- v2.1.2 2014-02-04
- v2.1.1 2013-11-8
- v2.1 2013-08-13
- v2.0.8 2015-12-17
- v2.0.7 2015-07-22
- v2.0.6 2015-03-04
- v2.0.5 2014-10-15
- v2.0.4 2014-02-04
- v2.0.3 2013-11-8
- v2.0.2 2013-08-13
- v2.0.1 2013-06-11
- v2.0 2013-05-10
- v1.8.2 2013-08-13
- v1.8.1 2013-05-10
- v1.8 2012-10-19
- v1.7.4 2013-08-13
- v1.7.3 2013-05-10
- v1.7.2 2012-10-19
- v1.7.1 2012-06-20
- v1.7 2012-05-09
- v1.6 2012-02-24
- v1.5.1 2012-01-04
- v1.5 2011-11-07
- v1.4.3.1 2011-09-30
- v1.4.3 2011-09-13
- v1.4.2 2011-08-05
- v1.4.1 2011-06-27
- v1.4 2011-05-19
- v1.3.3 2011-04-08
- v1.3.2 2011-03-15
- v1.3 2011-02-18
- v1.2 2010-11-25
- v1.1 2010-08-10
- v1.0.2 2010-08-27
- v1.0.1 2010-06-23
- v1.0 2010-05-11
- v0.11 2010-01-25
- v0.10 2009-09-30
- v0.9 2009-07-31
- v0.8 2009-04-10
- v0.7 2008-10-31
- v0.6 2008-07-08
- v0.5 2008-01-22
- v0.4 2007-07-04
- v0.3 2007-04-12
- v0.2 2007-02
- v0.1 2006-05