Update to reflect OIDC authentication support in pool tool #15
9 changed files with 26 additions and 17 deletions
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Deploy services
|
||||
weight: 1000
|
||||
weight: 30
|
||||
comment:
|
||||
Guides for deploying particular services, supporting the concept
|
||||
of a decentralized, interoperable infrastructure.
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 66 B After Width: | Height: | Size: 66 B |
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Generate an access token on the Hub
|
||||
weight: 30
|
||||
weight: 20
|
||||
---
|
||||
|
||||
1. Visit the [TRR379 collaboration hub]({{% ref "/references/services/collaboration-platform/" %}}) and log in with your credentials. If you do not have an account, see instructions on how to [get a Hub account and log in]({{% ref "/start/accounts/get-hub-account/" %}}) and to [configure your permissions]({{% ref "/start/accounts/permissions/" %}}).
|
||||
|
|
@ -7,10 +7,12 @@ weight: 10
|
|||
Follow these steps to create and/or edit your own profile, including uploading a portrait photo.
|
||||
|
||||
1. Navigate to the [knowledge pooling tool]({{% ref "/references/services/knowledge-pooling/" %}}).
|
||||
2. {{% expand title="Enter your token in the pool."%}}
|
||||
2. {{% expand title="Log in using your associated TRR379 hub account."%}}
|
||||
|
||||
- Click the "Settings" (gear) button.
|
||||
- Select the "TOKENS" tab, paste [your token]({{% ref "start/accounts/generate-token/" %}}), and click "SAVE".
|
||||
- Click the "Login" (human silhouette) button.
|
||||
- Select the "Login with TRR379 hub" option.
|
||||
- Read the disclaimer, and if you agree, select "Authorize Application".
|
||||
- A checkmark will appear on to the "Login" (human silhouette) button if you were successfully logged in.
|
||||
|
||||
{{% /expand %}}
|
||||
|
||||
|
|
|
|||
|
|
@ -8,10 +8,12 @@ Every member is responsible for submitting their own publications. Do not wait f
|
|||
{{% /notice %}}
|
||||
|
||||
1. Navigate to the [knowledge pooling tool]({{% ref "/references/services/knowledge-pooling/" %}}).
|
||||
2. {{% expand title="Enter your token in the pool."%}}
|
||||
2. {{% expand title="Log in using your associated TRR379 hub account."%}}
|
||||
|
||||
- Click the "Settings" (gear) button.
|
||||
- Select the "TOKENS" tab, paste [your token]({{% ref "start/accounts/generate-token/" %}}), and click "SAVE".
|
||||
- Click the "Login" (human silhouette) button.
|
||||
- Select the "Login with TRR379 hub" option.
|
||||
- Read the disclaimer, and if you agree, select "Authorize Application".
|
||||
- A checkmark will appear on to the "Login" (human silhouette) button if you were successfully logged in.
|
||||
|
||||
{{% /expand %}}
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ It comprises:
|
|||
|
||||
- A **web UI** for submitting, editing, and browsing records such as people, projects, and publications
|
||||
- A **backend API** allowing scripts and applications to contribute or retrieve metadata
|
||||
- **Token-based authentication** that integrates with Forgejo teams on the [collaboration platform]({{% ref "/references/services/collaboration-platform" %}}) to manage read and write permissions
|
||||
- **[OAuth 2.0]({{% ref "references/terms/oauth2" %}}) and token-based authentication** that integrates with Forgejo teams on the [collaboration platform]({{% ref "/references/services/collaboration-platform" %}}) to manage read and write permissions
|
||||
|
||||
The current (generation v0) tool can be accessed at:
|
||||
|
||||
|
|
@ -21,7 +21,8 @@ For technical information on the knowledge pooling tool and its data and privacy
|
|||
- https://pool.v0.trr379.de/
|
||||
|
||||
For information on using the knowledge pooling tool, see:
|
||||
- [Accounts & Access]({{% ref "start/accounts/" %}}) for getting set up, including creating a linked [Hub]({{% ref "references/services/collaboration-platform/" %}}) account and a personal access token for authentication purposes
|
||||
- [Accounts & Access]({{% ref "start/accounts/" %}}) for getting set up, including creating a linked [Hub]({{% ref "references/services/collaboration-platform/" %}}) account
|
||||
- [Submit to the Knowledge Pool]({{% ref "howtos/pool-tool/" %}}) for submitting, editing, and browsing records in the web UI
|
||||
- [Generate an Access Token on the Hub]({{% ref "advanced/generate-token/" %}}) for generating a personal access token for authentication purposes, particularly when working with the programmatic API
|
||||
- [`shacl-vue` Documentation](https://shacl-vue.psychoinformatics.de/) (external link) for the documentation for the knowledge pool's web UI.
|
||||
- [Dump Things Service Documentation](https://dump-things-service.readthedocs.io/en/latest/) (external link) for the documentation for the knowledge pool's backend API.
|
||||
|
|
|
|||
5
content/references/terms/oauth2.md
Normal file
5
content/references/terms/oauth2.md
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: OAuth 2.0
|
||||
---
|
||||
|
||||
[OAuth 2.0](https://oauth.net/2/) is an open standard protocol for authorization that allows applications to access data on another service without directly handling passwords themselves.
|
||||
|
|
@ -6,11 +6,10 @@ weight: 10
|
|||
The [TRR379 collaboration platform]({{% ref "/references/services/collaboration-platform/" %}}) (or "Hub" for short) is the platform for code and large dataset collaboration, and where access tokens for the [knowledge pooling tool]({{% ref "/references/services/knowledge-pooling/" %}}) are generated.
|
||||
The Hub runs an enhanced version of the [Forgejo](https://forgejo.org/) software.
|
||||
|
||||
Access to the [knowledge pooling tool]({{% ref "/references/services/knowledge-pooling/" %}}) is managed using **tokens** and **Forgejo teams**.
|
||||
Forgejo-based authentication ensures that permissions are linked to existing institutional or project accounts.
|
||||
Tokens are used to identify users interacting with the API or web UI.
|
||||
Only users with a valid access token can add or edit records.
|
||||
Access to the [knowledge pooling tool]({{% ref "/references/services/knowledge-pooling/" %}}) is managed using **[OAuth 2.0]({{% ref "/references/terms/oauth2" %}})** (and/or tokens) and **Forgejo teams**.
|
||||
Forgejo-based authentication ensures that permissions are linked to existing institutional or project accounts, and allows for identification of users interacting with the API or web UI.
|
||||
Only users logged in using an associated [Hub]({{% ref "/references/services/collaboration-platform/" %}}) account or using a valid access token can add or edit records.
|
||||
|
||||
Follow the guides below to create and configure your Hub account with appropriate permissions and generate an access token.
|
||||
Follow the guides below to create and configure your Hub account with appropriate permissions.
|
||||
|
||||
{{% children sort="weight" %}}
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ To assist with common issues you may encounter while working with the [knowledge
|
|||
## Tips
|
||||
|
||||
- It is **highly recommended** to use the knowledge pool's web UI with a desktop browser; the form offers rich contextual information that is hard to access on mobile devices.
|
||||
- Submitting records will only be possible using a [valid access token]({{% ref "/start/accounts/generate-token/" %}}); the token can be entered by navigating to "Settings" (gear icon) and then pasting your token in the "TOKENS" tab.
|
||||
- Submitting records will only be possible by logging in via [your TRR379 hub account]({{% ref "/start/accounts/" %}}) or using a [valid access token]({{% ref "/advanced/generate-token/" %}}); the token can be entered by navigating to "Settings" (gear icon) and then pasting your token in the "TOKENS" tab.
|
||||
- When editing records, you can hover your mouse pointer over field labels to display help text describing expected values and controlled vocabularies.
|
||||
- For some fields (e.g., journal name when filling out a Publication record), one or more choices have to be selected. The selector offers type-ahead search of choices. When searching:
|
||||
- Try entering full names instead of abbreviations.
|
||||
|
|
@ -19,7 +19,7 @@ To assist with common issues you may encounter while working with the [knowledge
|
|||
|
||||
## Common errors
|
||||
|
||||
- **Authorization issues**: If the [access token]({{% ref "/start/accounts/generate-token/" %}}) you are providing is incorrect or does not have appropriate permissions, the interface may display one or more of the following errors during metadata retrieval or submission:
|
||||
- **Authorization issues**: If the [access token]({{% ref "/advanced/generate-token/" %}}) you are providing is incorrect or your account does not have appropriate [permissions]({{% ref "/start/accounts/permissions/" %}}), the interface may display one or more of the following errors during metadata retrieval or submission:
|
||||
|
||||

|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue