Commit 5d00f429 authored by Beatriz Sanchez's avatar Beatriz Sanchez
Browse files

Update B2SHARE-install.md

parent 7c1b38aa
......@@ -27,7 +27,8 @@ be build by any user. During installation of the package it will use:
To install the B2SHARE-connect component you have to do following steps:
- clone the b2safe-b2share-connect project as any user. NOT root
``` $ git clone https://gitlab.eudat.eu/b2safe/b2safe-b2share-connect.git
```
$ git clone https://gitlab.eudat.eu/b2safe/b2safe-b2share-connect.git
```
- add following scripts to \<your path to B2SAFE\>/B2SAFE-core/cmd:
......@@ -37,7 +38,6 @@ To install the B2SHARE-connect component you have to do following steps:
* create_md_file.py
* irodsUtility.py
- add the rule “b2share.re” from B2SAFE-core/rulebase folder to the "rulebase" folder of your iRODS instance \<your path to B2SAFE\>/B2SAFE-core/rulebase
- add to your configuration folder \<your path to B2SAFE\>/B2SAFE-core/conf and modify the configuration file “b2share_client_example.json” according to your environment as described in "Configuration" section of this wiki page and rename it to “b2share_client.json”
- check for missing python libraries trying to run the major scripts with -d (dry run) option
......@@ -88,14 +88,18 @@ The first two sections `logging` and `b2share_http_api` are prefilled with defau
----------------
Following workflow was considered during the component development:
1. The user is registered at B2SHARE and has an B2SHARE access token. The user provides the b2share token to the B2SAFE administrator, who adds it to the user metadata: `imeta add
-u <irods_user_name> access_token <token_value>`
1. The user is registered at B2SHARE and has an B2SHARE access token. The user provides the b2share token to the B2SAFE administrator, who adds it to the user metadata:
```
`imeta add -u <irods_user_name> access_token <token_value>`
```
2. The user adds a specific metadata attributes to the collection, that will be used to create a draft:
```
`imeta add -C \<collection_X\> EUDAT_B2SHARE_PUBLISH EUDAT` with community name as the value, to publish the collection unter
`imeta add -C \<collection_X\> EUDAT_B2SHARE_TITLE Some_Title` and the title of the publication.
```
The `imeta ls -C \<collection_X\>` will then deliver:
The comand `imeta ls -C \<collection_X\>` will then deliver:
```
AVUs defined for collection collection_X:
attribute: EUDAT_B2SHARE_PUBLISH
......@@ -123,42 +127,6 @@ Following assumptions were made:
* the collections are copied and published just one time, even if the rule to publish them is executed multiple times.
NOTE: following needs to be updated/added in "/opt/eudat/b2safe/packaging/install.conf":
- DEFAULT_RESOURCE
- SERVER_ID
- HANDLE_SERVER_URL (needed for epicclient2)
- PRIVATE_KEY (needed for epicclient2)
- CERTIFICATE_ONLY (needed for epicclient2)
- PREFIX (needed for epicclient2)
- HANDLEOWNER (needed for epicclient2)
- REVERSELOOKUP_USERNAME (needed for epicclient2)
- HTTPS_VERIFY (needed for epicclient2)
- AUTHZ_ENABLED (default=true)
- MSG_QUEUE_ENABLED (default=false)
# update /opt/eudat/b2safe/conf/b2share_client.json with the parameters of your b2safe/irods intallation
and with your access parameters for your b2share instance
- check the python scripts for missing python libraries.
$ cd /opt/eudat/b2safe/cmd
$ ./authZmanager.py -h
$ ./epicclient2.py --help
$ ./logmanager.py -h
$ ./messageManager.py -h
$ ./metadataManager.py -h
$ ./timeconvert.py epoch_to_iso8601 2000000
Try to install missing packages with the standard package manager like apt, yum, zypper etc.
If packages are not within the standards use pip and install the missing packages with pip.
DONE
== B2SHARE ==
find information about how to use it in
https://eudat.eu/services/userdoc/the-b2share-http-rest-api#UserDocumentation-B2SHARE-Authentication
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment