JavaScript is not currently enabled, but is required for full
CodeSonar manual search and browse functionality.
If you are viewing this file in your hub's Web GUI, enable
JavaScript in your browser: you will also need it for GUI
functionality.
If you opened this file directly from disk, your browser may be
directly suppressing JavaScript functionality: certain browsers
perform this suppression on local files (but not files delivered by
web servers) for security reasons.
-
If you access the manual through the hub's Web GUI, the
functionality will not be suppressed because the hub is a web
server.
-
Alternatively, your browser may allow you to explicitly
disable the security setting that suppresses functionality. See
the CodeSonar
FAQ for more information.
Installation: Hub Setup: Connecting to a Existing Hub
This section is for users who need to connect to an existing
CodeSonar Hub as part of the
CodeSonar installation.
If you are responsible for creating or upgrading the hub and
have not already done so, go back to Installation: Setting Up The Hub and
use the decision tree provided to navigate to the appropriate hub
setup instructions.
CodeSonar SaaS Note: if you are
using CodeSonar SaaS, use the instructions in this page to connect
to your SaaS hub.
Connecting to an existing CodeSonar hub involves two major
steps.
- A. Obtain information about the hub
location.
- B. Connect to the hub.
The remainder of this page describes these steps and provides
links to further information.
To connect to a CodeSonar hub, you will need to determine the
hub location.
- If you do not already know the hub's network host
and port, obtain this information before proceeding.
The hub must be running in order for you to connect to it. If
necessary, ask its owner to start it before proceeding.
Once you have determined the hub location,
connect to the hub as follows.
- If the CodeSonar
configuration tool is not already running, start it now.
codesonar config
Windows users can also select CodeSonar
> CodeSonar Configuration Tool from the Windows Start
menu.
The configuration tool main
menu will be displayed.
- Enter 1 at the prompt to
select option 1 ("Install, connect to existing hub") from
the main menu.
- The configuration tool will ask you for various information
about the hub you want to connect to.
- ... the hub host name or IP address.
- If necessary, specify the exact interface you have
selected.
- ... the port number for the hub.
- Enter the port on which the hub is listening. The
default is 7340.
- The tool will ask for various information in order to determine
how you want this CodeSonar installation to interact with the hub
when you perform analyses.
- ... whether you have an existing user account on
the hub.
- Enter yes or
no.
- yes: you will be
prompted for the hub user account username.
- no: you will be
prompted for a username and email address to use in
creating a new hub user account
The hub user account you specify here will be associated with
the launch daemon
that your analyses will use to communicate with the hub.
- whether analyses with this installation should use this hub
by default.
- Enter the menu option number corresponding to your
preference.
- ... which kinds of C/C++ warnings to detect, that is, which
configuration presets
you want to define as default
presets for all analyses. You may enable or disable one or
more presets while connecting to the hub. Note that you may
choose to run analyses without processing the default presets
by specifying -no-default-presets
in your command.
- Enter the menu option number corresponding to your
preference.
- ... your preferred analysis speed: a tradeoff against
analysis thoroughness.
- Enter the menu option number corresponding to your
preference, then confirm your choice.
- [SaaS hubs only] If you are connecting to a SaaS hub, the
configuration tool will now ask if you would like to default to
performing analyses using the SaaS cloud instead of your own
resources. Enter yes or
no.
- yes: the tool will set
up the hub connection and go on to
the next stage.
- no: the tool will
continue to collect information.
- ... the level of analysis parallelism to use
for analyses on the new hub.
- Enter the menu option number corresponding to your
preference.
Note that this setting pertains to analyses performed by
you, on this machine, with this CodeSonar installation, on
the new hub.
- ... whether analyses should utilize the hub's
analysis cloud: that is, whether they should be distributed
analyses.
- Enter the menu option number corresponding to your
preference.
- ... whether analyses should contribute to the
hub's analysis cloud: that is, whether you want to
contribute resources (where available) to distributed analyses
started on other machines, or by other users, or by other
CodeSonar installations.
If you answered "Yes" to the previous question we
strongly recommend that you answer "Yes" to this
question. If you answer "No", your launch daemon will not
start slaves for any distributed analyses, including
your own.
- Enter the menu option number corresponding to your
preference.
- ... the parent launchd
group for the launch daemon that your
analyses will use to communicate with the hub.
Unless your hub administrator has instructed otherwise, use
the root launchd group.
- Enter / to specify the
root launchd group.
- ... [Windows only] whether the launch daemon should run as
a service (see section
CodeSonar as a Windows Service for more information).
- Enter the menu option number corresponding to your
preference.
-
The tool will provide
information or functionality for accessing the hub's
Home page.
- [Windows] The tool will ask whether you want to view the
hub in your browser once the connection has been hub has been
configured.
- [other systems] The tool will print a message specifying
the Home page URL.
- Open the URL in a web browser.
- [New hub user account only] If you specified a new user account
username in step 4a, the tool will prompt you to set up a password
for the new user account.
- Enter the password at the prompt.
- When prompted, enter the password again for
confirmation.
- CodeSonar will now set up a connection to the hub.
- If prompted, enter the hub user account password associated
with the username you specified in step 4a. This authenticates
the new launch daemon.
- When prompted, press Enter to
continue.
[Windows only] If the command appears to be taking a long time
to finish, it may be waiting for services authentication. (If you
are working in other windows while running CodeSonar those
windows might be obscuring the authentication dialog: if you
don't see a dialog, move the other windows to check
underneath). See CodeSonar
as a Windows Service for more information.
- If User Account Control is enabled, your system may request
permission for CodeSonar to start a launch daemon.
Click Continue to
proceed.
- When prompted, press Enter to
continue.
- The configuration tool main
menu will be displayed, and the hub you have connected to
should appear in the table of known
hubs.
- If there is a firewall on your system, you may need to
configure it to permit connections to and from the hub. See
FAQ: How do I allow hub access
through a firewall?.
- Go on to Installation:
Finishing Up.