No project description provided
Project description
ckanext-vip-portal
Generic access restrictions for anonymous user.
Configure the set or endpoints/URLs that are available for the anonymous user, and redirect to the login page if he attempts to visit non-whitelisted page.
Requirements
Compatibility with core CKAN versions:
CKAN version | Compatible? |
---|---|
2.9 | yes |
2.10 | not yet |
Installation
To install ckanext-vip-portal
:
-
Install it using pip
pip install ckanext-vip-portal
-
Add
vip_portal
to theckan.plugins
setting in your CKAN config file.
Config settings
# Configure endpoint that handles unauthorized page access
# (optional, default: user.login).
ckanext.vip_portal.login_endpoint = auth_ext.login
# Allow anonymous access to all the pages. It basically disables
# current extensions
# (optional, default: false).
ckanext.vip_portal.free_anonymous_access = true
# Allow any authenticated user to visit pages normally
# (optional, default: true).
ckanext.vip_portal.free_authenticated_access = false
# Allow anonymous access to login pages
# (optional, default: true).
ckanext.vip_portal.allow_login = false
# Allow anonymous access to password reset page
# (optional, default: true).
ckanext.vip_portal.allow_password_reset = false
# Allow anonymous access to registration pages
# (optional, default: true).
ckanext.vip_portal.allow_registration = false
# Allow anonymous access to API endpoints
# (optional, default: true).
ckanext.vip_portal.allow_api = false
# Additional endpoints that are accessible by anonymous user
# (optional, default: empty).
ckanext.vip_portal.extra_allowed_endpoints = home.index home.about dataset.search
# Additional paths(URLs) that are accessible by anonymous user
# (optional, default: empty).
ckanext.vip_portal.extra_allowed_paths = / /about /dataset
# Allow anonymous user to access any path that starts with the following prefixes
# (optional, default: empty).
ckanext.vip_portal.extra_allowed_prefixes = /dataset /organization /group /static
# Allow anonymous user to access any path that ends with the following suffixes
# (optional, default: empty).
ckanext.vip_portal.extra_allowed_suffixes = .svg .html .css
Developer installation
To install ckanext-vip-portal
for development, activate your CKAN virtualenv and
do:
git clone https://github.com/DataShades/ckanext-vip-portal.git
cd ckanext-vip-portal
pip install -e '.[dev]'
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ckanext-vip-portal-0.1.0.tar.gz
(19.0 kB
view hashes)
Built Distribution
Close
Hashes for ckanext_vip_portal-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4b5a22434c7f8ef2852721fbe061eb4d52c6943a1c6c98a02a946fbfe48bcdd |
|
MD5 | 13682a54d968e696b4ac0816bc3d0ef3 |
|
BLAKE2b-256 | 8b052edd98accb42511fe6e7da1bf7d47ac073f9f46021518ddd07814aad9476 |