Creates Standalone Configuration Information Section in Documentation

[JREastonMarks]

#11373 Creates Standalone Configuration Information Section in Documentation

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[fuzhaoyuan]

Just a small typo

Suggested change

Our docker configuration is based off the default cBioPortal docker configuration however we have made some changes to support our requirements. We create two networks in this deployment. The first being a bridge network that allows the services to connect to the outside world. The second is an internal network that only allows for services to talk to other services in that network. Most of the services are configured to use the internal network, with the exception being the NGINX and cBioPortal services. The NGINX needs to be able to communicate with the outside world in order to make the cBioPortal instance available to the outside world. The cBioPortal instance needs to be able to communicate with the outside world in order to allow for authentication with an outside service. However, if the cBioPortal instance does not authentication then the service can be deployed only on the internal network.

Our docker configuration is based off the default cBioPortal docker configuration however we have made some changes to support our requirements. We create two networks in this deployment. The first being a bridge network that allows the services to connect to the outside world. The second is an internal network that only allows for services to talk to other services in that network. Most of the services are configured to use the internal network, with the exception being the NGINX and cBioPortal services. The NGINX needs to be able to communicate with the outside world in order to make the cBioPortal instance available to the outside world. The cBioPortal instance needs to be able to communicate with the outside world in order to allow for authentication with an outside service. However, if the cBioPortal instance does not authenticate then the service can be deployed only on the internal network.

[fuzhaoyuan]

LGTM. Will it show up somewhere in the Docs? Looks like it will

[inodb]

This looks great to me! Thanks @JREastonMarks !

A few small things:

• To get the doc to show up in the TOC, you'll need to add it to SUMMARY.md
• We recently started adding an addon/ folder to the cbioportal-docker-compose repo (see for clickhouse: https://github.com/cbioPortal/cbioportal-docker-compose#clickhouse-mode). Idea being that you could sorta layer in additional services etc by adding additional compose files. Maybe some of the compose code in the docs could go there. Not necessary to do now tho, but maybe a good follow up. I included @zainasir to review
• OncoKB data requires a license, it doesn't seem to be explicitly mentioned here?