6.6 KiB
Storages
Here you can read which storage engines are supported. And how they can be used. Per storage engine there is a short description how to setup.
Per storage engine the following options needs to be specified
- location: Full path of the storage engine or API
- username: The username that is able to connect to the storage
- password: The password that is needed to connect to the storage
When we connect a storage to a study, the options to set a storage path and encryption will become available. So you are able to reuse the same storage configuration for multiple studies, but per combination storage/study you can specify storage paths, encryption, notification etc
Gitea
In order to use Gitea as a storage, you need to create an 'Application' in Gitea. This will create a new token that is used for authenticating with the API.
Creating access token
Login into the Gitea server with a webrowser and go to your 'Applications' in your 'Settings'.
- Click on you profile menu
- Click on 'Settings'
- Click on 'Applications'
- Enter a name for this Application.
Then press the 'Generate token' button and a new token will be generated with the new Application.
- Store the token somewhere save
- Here is your newly created Application with the latest activity. This will show you the last time this Application is used.
- Here you can delete the Application. This will revoke the token, and will block new API calls and uploads.
Research Workspaces Storage values
Now we have created an Gitea API Application we can use this in the Research Workspaces Dropoff Storage settings.
- location: https://[gitea.host.com]/api/v1#[Your_Repository_Name] (It is important to add '/api/v1' to the url)
- username: Your own username
- password: The saved Application token at step 5
Github
In order to use Gitea as a storage, you need to create an 'Application' in Gitea. This will create a new token that is used for authenticating with the API.
Creating access token
Login into the Github with a webrowser and follow the steps below to make an API token.
- Click on you profile menu
- Click on 'Settings'
- Click on 'Developer settings'
- Click on 'Personal access tokens'
- Click on 'Generate new token'
- Enter a name
- Select the Repo checkbox.
- Store the token somewhere save
- Here is your newly created Application with the latest activity. This will show you the last time this Application is used.
- Here you can delete the Application. This will revoke the token, and will block new API calls and uploads.
Research Workspaces Storage values
Now we have created an Github.com API Application we can use this in the Research Workspaces Dropoff Storage settings.
- location: https://api.github.com#[Your_Repository_Name]
- username: Your own username
- password: The saved Application token at step 8
WebDAV
In order to use a WebDAV server as a storage there are different ways of creating API tokens and/or authentication. So for WebDAV we have steps per working known WebDAV servers.
Owncloud/Nexcloud/Unishare
Creating access token
Login into the Owncloud/Nexcloud/Unishare server with a webrowser and go to your 'Security' in your 'Settings'.
- Click on you profile menu
- Click on 'Settings'
- Click on 'Security'
- Enter a name for this Application.
- Press the 'Generate token' button and a new token will be generated with the new Application.
- Store the token somewhere save
- Here is your newly created Application with the latest activity. This will show you the last time this Application is used.
- Here you can delete the Application. This will revoke the token, and will block new API calls and uploads.
Research Workspaces Storage values
System Message: WARNING/2 (<stdin>, line 151)
Title underline too short.
Research Workspaces Storage values ------------------
Now we have created an Owncloud/Nexcloud/Unishare API Application we can use this in the Research Workspaces Dropoff Storage settings. For Owncloud/Nexcloud/Unishare there are some extra steps to get the right WebDAV settings.
- Go to the Files Application
- Click on the Settings icon
- Copy the url value at the field WebDAV. Make sure you copy the full path
- location: https://unishare.nl/remote.php/dav/files/
- username: Your own username shown at step 6
- password: The saved Application token at step 6
iRODS
In order to use iRODS as a storage, you need to enter some credential values in the the data storage form.
Creating access token
There is no need for creating separate access tokens. As iRODS does not support multiple login tokens per user, we need to use the same credentials as the user is using when reading data from the iRODS server.
Keep in mind, that when you change the iRODS credentials (due to missing password), you need to update the credentials here as well.
As iRODS works with federation, you need to know your iRODS zone. This will be added to the address location when entering iRODS credentials.
Research Workspaces Storage values
- location: hostname or ip of the iRODS server with '#[iRODS ZONE NAME]' appended
- username: Your own username
- password: Your own password