Merge pull request #3 from Sage-Bionetworks/dockerization

perf: add instructions on dockerization

.github/workflows/Release_Docker_build.yml

@@ -27,7 +27,7 @@ jobs:
         uses: mathieudutour/[email protected]
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          custom_release_rules: fix:patch:Bug Fixes,chore:patch:Chores,feat:minor:Features,perf:Major:Performance
+          custom_release_rules: fix:patch:Bug Fixes,chore:patch:Chores,feat:minor:Features,perf:major:Performance
       - name: Create a GitHub release
         uses: ncipollo/release-action@v1
         with:

README.Rmd

@@ -49,6 +49,21 @@ installation you choose should have synapseclient installed.
 Because dccvalidator uses reticulate, it is not compatible with the
 [synapser](https://r-docs.synapse.org/) package.
 
+## Dockerize the App
+### Authentication
+The dccmonitor can be authorized to log in to Synapse using Synapse Authentication (OAuth) client. Please view instructions [here](https://help.synapse.org/docs/Using-Synapse-as-an-OAuth-Server.2048327904.html#UsingSynapseasanOAuthServer-RegisteringandLinkinganOAuth2.0Client) to learn how to request a client. Our OAuth clients were created using Synapse service accounts in order to enable multiple Sage employees to maintain the applications. In the Shared-SysBio LastPass folder, credentials for each client are recorded. In the notes section of the credentials (click on the entry > Edit to see notes), the service account used to create the client is noted.
+
+### Build a docker image using Dockerfile
+```
+docker build -t dccvalidator_pec -f Dockerfile .  
+```
+
+### Create a container from the docker image
+```
+docker run --rm -it -p 8100:3838 -e APP_REDIRECT_URL=<APP_REDIRECT_URL> -e R_CONFIG_ACTIVE=pec -e client_id=<Oauth client id> -e client_name=<Oauth client name> -e client_secret=<Oauth client secret> --name <container name> dccvalidator_pec
+```
+Once the container is created, you can head to the APP_REDIRECT_URL you specified to enter the app. 
+
 ## Check data
 
 dccvalidator provides functions for checking the following common data quality