Intended audience

  • deposit clients

  • sysadm staff members

Register account#

Becoming a deposit client is very easy, just write to deposit@softwareheritage.org to setup the deposit partner agreement. With the agreement signed you can follow the steps below.

As a deposit client#

For this, as a client, you need to register an account on the swh keycloak production or staging instance.

As a sysadm#

  1. Retrieve the deposit client login (through email exchange or any other media).

  2. Require a provider url from the deposit client (through email exchange or any other media).

  3. Within the keycloak production instance or staging instance, add the swh.deposit.api role to the deposit client login.

  4. Create an associated deposit collection in the deposit instance.

  5. Create a deposit client 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).