From 1057accfe6141ec5ddd5bfa7cb5b505ebb15b9ca Mon Sep 17 00:00:00 2001 From: Al Fontaine Date: Thu, 26 Aug 2021 18:01:42 +0000 Subject: [PATCH] Update README.md --- README.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5dc6fa6..6f22199 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,35 @@ -# +## CodeSonar 6.1p0 + +This is a default image that provides the CodeSonar Hub service. Data volumes can +be mounted such that data persists. A license from GrammaTech is required to be +able to use the hub and provide scans. Contact sales@grammatech.com for access +to a license. + +## Build the Image +Build the image using the standard + `docker build -t codesonar-hub .` + +## Running the Container +Suggested use is to run the container using: + +`docker volume create hub` + +`docker network create --driver bridge net ` + +`docker run -d --name hub -p 8080:7340 -v hub:/home/codesonar/hub --network net codesonar-hub` + +This will put all data in the hub volume and route localhost:8080 to the hub and +connect the container to network net such that scanners can connect to it. + + +## Shutdown +Recommended to shutdown the container through +`http://[host]:[port]/command/shutdown` before terminating the container + +## Resources +CPU Min/Recommended 2/8+
+RAM Min/Recommended/Max 2G/8G/Unlimited + +## Ports +Application is using port 7340 -Project template for all Iron Bank container repositories. \ No newline at end of file -- GitLab