To run your own RSD instance you can use deployment.zip file provided in the RSD release.
deployment.zipfile. It contains:
.env.exampleis an environment example file
CITATION.cffcontains citation information of RSD software.
docker-compose.ymldefines all required RSD services and exposes environment variables used by each service
nginx.confbasic nginx configuration file.
Rename or copy
.envand provide the values in the SECRETS section of .env file. Please do not use special characters in the
.envfile. For the minimal local setup you should provide values for these variables
- Start RSD using docker compose
docker compose up
- Visit http://localhost and confirm that the RSD is running
Login using local account
To be able to login to RSD you need to enable at least one authentication provider. For testing purposes we offer the local account option. To enable it use
LOCAL value in
RSD_AUTH_PROVIDERS property in .env file.
# consumed by services: frontend (api/fe)
# provide a list of supported OpenID auth providers
# the values should be separated by semicolon (;)
# if env value is not provided default provider is set to be SURFCONEXT
# if you add the value "LOCAL", then local accounts are enables, USE THIS FOR TESTING PURPOSES ONLY
When changing values of environment variables in .env file you need to restart RSD. Use
docker compose down followed by
docker compose up -d
At this point you should be able to see RSD instance running. You should also be able to login using Local account by providing any username, for example
Tester. In order to be able to make changes to RSD please accept the Terms of Service and the Privacy Statement after loging in.
The local account login option is only for test purposes. Local accounts do not require a password and are therefore not safe.
Log in as RSD administrator
To be able to log in as RSD administrator, the account id of that account needs to be in the database table
To do so, connect to the database and execute the following query, changing the value of the UUID:
INSERT INTO admin_account VALUES ('00000000-0000-0000-0000-000000000000');
A user can see their account ID in their user settings page, which they can find under the
My settings option in the profile dropdown menu.
If that user is already logged in, they need to log out and log in again before they can make use of their admin rights.
When you log in to the RSD as administrator, you will see an additional "Administration" option in the profile dropdown menu.