Skip to content
Snippets Groups Projects
Commit 3ee9c9bf authored by Renaud Boyer's avatar Renaud Boyer
Browse files

wip howto

parent e3b68742
No related branches found
No related tags found
No related merge requests found
......@@ -7,8 +7,8 @@ Becoming a deposit client is very easy, just write to deposit@softwareheritage.o
to setup the deposit partner agreement. With the agreement signed you can follow the
steps below.
For this, as a client, you need to register an account on the swh keycloak `production
<https://archive.softwareheritage.org/oidc/login/>`_
or `staging
<https://webapp.staging.swh.network/oidc/login/>`_
instance.
\ No newline at end of file
For this, as a client, you need to register an account on the swh keycloak
`production <https://archive.softwareheritage.org/oidc/login/>`_
or `staging <https://webapp.staging.swh.network/oidc/login/>`_ instance.
Once you have an account, you should get a set of access credentials as a login and a password (identified as <name> and <pass> in the remaining of this documentation). A deposit account also comes with a “provider URL” which is used by SWH to build the Origin URL of deposits created using this account.
\ No newline at end of file
Contribute to swh-deposit
=========================
Contribute to deposit
=====================
Work groups
-----------
......
......@@ -39,7 +39,7 @@ Partial
Check its status
----------------
Your deposit will go :doc:`through multiple steps </references/workflow>` before appearing in the archive, You can check the status of your deposit ang get its SWHID :
Your deposit will go :doc:`through multiple steps </references/workflow>` before appearing in the archive, You can check the status of your deposit ang get its SWHID:
.. tab-set::
......
Self-host swh-deposit
=====================
TODO
Register a client account
-------------------------
1. Retrieve the deposit client login (through email exchange or any other media).
2. Require a :ref:`provider url <swh-deposit-provider-url-definition>` from the deposit
client (through email exchange or any other media).
3. Within the keycloak `production instance <https://auth.softwareheritage.org/auth/admin/SoftwareHeritage/console/#/realms/SoftwareHeritage>`_ or `staging
instance <https://auth.softwareheritage.org/auth/admin/SoftwareHeritageStaging/console/#/realms/SoftwareHeritageStaging>`_, add the `swh.deposit.api` role to the deposit
client login.
4. Create an :ref:`associated deposit collection
<swh-deposit-add-client-and-collection>` in the deposit instance.
5. Create :ref:`a deposit client <swh-deposit-add-client-and-collection>` with the
provider url in the deposit instance.
6. To ensure everything is ok, ask the deposit client to check they can access at least
the service document iri (authenticated).
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment