UNCLASSIFIED

README.md 1.33 KB
Newer Older
Mark Hermeling's avatar
Mark Hermeling committed
1
## CodeSonar 5.4p0
Mark Hermeling's avatar
Mark Hermeling committed
2 3 4 5 6 7

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.

Mark Hermeling's avatar
Mark Hermeling committed
8
## Build the Image
Mark Hermeling's avatar
Mark Hermeling committed
9
Build the image using the standard
Mark Hermeling's avatar
Mark Hermeling committed
10
  `docker build -t codesonar-hub .`
Mark Hermeling's avatar
Mark Hermeling committed
11

Mark Hermeling's avatar
Mark Hermeling committed
12
## Running the Container
Mark Hermeling's avatar
Mark Hermeling committed
13
Suggested use is to run the container using:
Mark Hermeling's avatar
Mark Hermeling committed
14

Mark Hermeling's avatar
Mark Hermeling committed
15
`docker volume create hub`
Mark Hermeling's avatar
Mark Hermeling committed
16

Mark Hermeling's avatar
Mark Hermeling committed
17
`docker network create --driver bridge net `
Mark Hermeling's avatar
Mark Hermeling committed
18

Mark Hermeling's avatar
Mark Hermeling committed
19
`docker run -d --name hub -p 8080:7340 -v hub:/home/codesonar/hub --network net codesonar-hub`
Mark Hermeling's avatar
Mark Hermeling committed
20 21 22 23

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.

Mark Hermeling's avatar
Mark Hermeling committed
24 25 26
The hub will have default password for the `Administrator account` set to 
`HubSecretPasswd` at creation-time, which can be changed by 
`--build-arg HUB_DEFAULT_PWD=YourOwnSecretPWD` during the container build step.
Mark Hermeling's avatar
Mark Hermeling committed
27 28 29
Please change the default password after initial hub creation. This is also the
time to install the run-time license.

Mark Hermeling's avatar
Mark Hermeling committed
30 31 32 33
## Shutdown
Recommended to shutdown the container through
`http://[host]:[port]/command/shutdown` before terminating the container

Mark Hermeling's avatar
Mark Hermeling committed
34 35
## Resources
CPU Min/Recommended 2/8+<br>
Mark Hermeling's avatar
Mark Hermeling committed
36
RAM Min/Recommended/Max 2G/8G/Unlimited
Mark Hermeling's avatar
Mark Hermeling committed
37

Mark Hermeling's avatar
Mark Hermeling committed
38
## Ports
Mark Hermeling's avatar
Mark Hermeling committed
39
Application is using port 7340
Joshua Eason's avatar
Joshua Eason committed
40