-
Notifications
You must be signed in to change notification settings - Fork 0
Development Instructions
This page covers a few details helpful for development on our fork that can't be added to the README. The instructions in the README are perfectly functional but slightly generic. Please read the instructions in this wiki then follow the README instructions.
When you reach step 3 of the section "How to build and run the RSD" in the README you can use the below text as your .env file rather than having to copy and edit .env.example. This file has a generated set of secrets and has configured the "local" authentication mechanism. It's much more parred down so if you want to see what any of the config options do .env.example is a useful reference. It goes without saying that this version of the .env file should never be used in a deployment.
COMPOSE_PROJECT_NAME="rsd"
POSTGRES_DB_HOST=database
POSTGRES_DB_HOST_PORT=5432
POSTGRES_DB=rsd-db
POSTGRES_USER=rsd
PGRST_DB_ANON_ROLE=rsd_web_anon
PGRST_DB_SCHEMA=public
PGRST_SERVER_PORT=3500
POSTGREST_URL=http://backend:3500
POSTGREST_URL_EXTERNAL=http://localhost/api/v1
RSD_AUTH_URL=http://auth:7000
RSD_AUTH_PROVIDERS=LOCAL
[email protected]
MAX_REQUESTS_GITHUB=6
MAX_REQUESTS_GITLAB=6
MAX_REQUESTS_DOI=6
# ---- SECRETS ------ SECRETS -----------
POSTGRES_PASSWORD=fmubhwjkoazejagranpyrutsuufdpswp
POSTGRES_AUTHENTICATOR_PASSWORD=ckhebyiivhnecjljioveikkzatqqvoyk
PGRST_JWT_SECRET=jzzfbyhtkmlpssytobtfilyybrugqsqp
We have test deployment of the RSD currently hosted on an Azure VM at https://172.167.73.143. There is a self-signed security certificate in place so you'll be prompted with a security warning the first time you access the server.
Authentication is currently provided via Orcid. There is a configured list of Orcid ID's that are allowed to register. If you want access ask Chris and he'll add your Orcid ID.
In order to be able to deploy to our test server we have setup a dedicated branch (imperial) that builds and pushes docker images for the frontend, database and authentication services. To deploy to our local test server, feature branches should be merged into the imperial branch.