forked from IQSS/dataverse
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from poikilotherm/7025-orcid-public
7025 orcid public
- Loading branch information
Showing
78 changed files
with
2,163 additions
and
826 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
### Custom Analytics Code Changes | ||
|
||
You should update your custom analytics code to implement necessary changes for tracking updated dataset and file buttons. There was also a fix to the analytics code that will now properly track downloads for tabular files. | ||
|
||
We have updated the documentation and sample analytics code snippet provided in [Installation Guide > Configuration > Web Analytics Code](http://guides.dataverse.org/en/latest/installation/config.html#web-analytics-code) to reflect the changes implemented in this version (#6938/#6684). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
## Notes for Dataverse Installation Administrators | ||
|
||
### Location Changes for Related Projects | ||
|
||
The dataverse-ansible and dataverse-previewers repositories have been moved to the GDCC Organization on GitHub. If you have been referencing the dataverse-ansible repository from IQSS and the dataverse-previewers from QDR, please instead use them from their new locations: | ||
|
||
<https://github.com/GlobalDataverseCommunityConsortium/dataverse-ansible> | ||
<https://github.com/GlobalDataverseCommunityConsortium/dataverse-previewers> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
Mail Domain Groups | ||
================== | ||
|
||
Groups can be defined based on the domain part of users (verified) email addresses. Email addresses that match | ||
one or more groups configuration will add the user to them. | ||
|
||
Within the scientific community, in many cases users will use a institutional email address for their account in a | ||
Dataverse installation. This might offer a simple solution for building groups of people, as the domain part can be | ||
seen as a selector for group membership. | ||
|
||
Some use cases: installations that like to avoid Shibboleth, enable self sign up, offer multi-tenancy or can't use | ||
:doc:`ip-groups` plus many more. | ||
|
||
.. hint:: Please be aware that non-verified mail addresses will exclude the user even if matching. This is to avoid | ||
privilege escalation. | ||
|
||
Listing Mail Domain Groups | ||
-------------------------- | ||
|
||
Mail Domain Groups can be listed with the following curl command: | ||
|
||
``curl http://localhost:8080/api/admin/groups/domain`` | ||
|
||
Listing a specific Mail Domain Group | ||
------------------------------------ | ||
|
||
Let's say you used "domainGroup1" as the alias of the Mail Domain Group you created below. | ||
To list just that Mail Domain Group, you can include the alias in the curl command like this: | ||
|
||
``curl http://localhost:8080/api/admin/groups/domain/domainGroup1`` | ||
|
||
|
||
Creating a Mail Domain Group | ||
---------------------------- | ||
|
||
Mail Domain Groups can be created with a simple JSON file: | ||
|
||
.. code-block:: json | ||
:caption: domainGroup1.json | ||
:name: domainGroup1.json | ||
{ | ||
"name": "Users from @example.org", | ||
"alias": "exampleorg", | ||
"description": "Any verified user from Example Org will be included in this group.", | ||
"domains": ["example.org"] | ||
} | ||
Giving a ``description`` is optional. The ``name`` will be visible in the permission UI, so be sure to pick a sensible | ||
value. | ||
|
||
The ``domains`` field is mandatory to be an array. This enables creation of multi-domain groups, too. | ||
|
||
Obviously you can create as many of these groups you might like, as long as the ``alias`` is unique. | ||
|
||
To load it into your Dataverse installation, either use a ``POST`` or ``PUT`` request (see below): | ||
|
||
``curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/groups/domain --upload-file domainGroup1.json`` | ||
|
||
Updating a Mail Domain Group | ||
---------------------------- | ||
|
||
Editing a group is done by replacing it. Grab your group definition like the :ref:`above example <domainGroup1.json>`, | ||
change it as you like and ``PUT`` it into your installation: | ||
|
||
``curl -X PUT -H 'Content-type: application/json' http://localhost:8080/api/admin/groups/domain/domainGroup1 --upload-file domainGroup1.json`` | ||
|
||
Please make sure that the alias of the group you want to change is included in the path. You also need to ensure | ||
that this alias matches with the one given in your JSON file. | ||
|
||
.. hint:: This is an idempotent call, so it will create the group given if not present. | ||
|
||
Deleting a Mail Domain Group | ||
---------------------------- | ||
|
||
To delete a Mail Domain Group with an alias of "domainGroup1", use the curl command below: | ||
|
||
``curl -X DELETE http://localhost:8080/api/admin/groups/domain/domainGroup1`` | ||
|
||
Please note: it is not recommended to delete a Mail Domain Group that has been assigned roles. If you want to delete | ||
a Mail Domain Group, you should first remove its permissions. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.