Embargo content indefinitely or till specified date, limiting access to specific users and/or IP addresses.
This module is intended to be a successor to https://github.com/discoverygarden/embargoes
Install as usual.
Migrations exist in the migrate_embargoes_to_embargo module for migrating from embargoes's entities onto embargo's.
See the module's docs for more info.
Configuration options can be set at admin/config/content/embargo,
including a contact email and notification message.
Embargoes can be managed at admin/content/embargo.
To add an IP range for use on embargoes, navigate to
admin/content/embargo/range and click 'Add IP range'. Ranges
created via this method can then be used as IP address whitelists when creating
embargoes. This CIDR to IPv4 Conversion utility
can be helpful in creating valid CIDR IP ranges.
We have multiple search_api processors which attempt to constrain search
results based on the effects of embargoes on the entities represented by search
results, including:
embargo_processor("Embargo access (deprecated)")- Adds additional properties to the indexed rows, requiring additional index
maintenance on mutation of the entities under consideration, but should
theoretically work with any
search_apibackend
- Adds additional properties to the indexed rows, requiring additional index
maintenance on mutation of the entities under consideration, but should
theoretically work with any
embargo_join_process("Embargo access, join-wise")- Requires Solr/Solarium-compatible index, and indexing of embargo entities in the same index as the node/media/files to be search, tracking necessary info and performing Solr joins to constrain results
Typically, only one should be used in any particular index.
An embargo can be applied to an existing node by clicking the
"Embargoes" tab on a node, or navigating to
embargoes/node/{node_id}. From here, an embargo can be applied if it doesn't
already exist, and existing embargoes can be modified or removed.
- Embargoed items show up in search results
- Enable one of our
search_apiprocessors to handle applying embargo restrictions.
- Enable one of our
- "Embargo access, join-wise" does not show up as an available processor
- Ensure embargo entities are being indexed in the given index.
- Ensure that eligible node/media/files entities are being indexed in the given index.
Having problems or solved a problem? Contact discoverygarden.
This module is heavily based on and includes contributions from discoverygarden/embargoes which was forked from fsulib authored by Bryan J. Brown.