Installation¶
CodeScene is quite flexible in that you can run it in any environment that meets the requirements specified in Configure your Environment.
In general, there are two popular options for hosting CodeScene:
- CodeScene inside a Docker container: We have an example on a docker file here, including an example on how to configure SSL. With this option, you could also deploy CodeScene to a private cloud (e.g. aws). In this case, you’d use the standalone CodeScene application.
- CodeScene hosted by Tomcat: Tomcat might be an option if you already host other applications on Tomcat.
Run the Standalone CodeScene Application¶
The easiest way to get CodeScene up and running is by launching the standalone JAR:
java -jar codescene.standalone.jar
This will launch a web application that listens on port 3003 (you can
override that by setting a different port through the environment
variable CACS_RING_PORT
.
CodeScene will create a local database for the analysis configurations.
By default the database file resources/caacs_enterprise.db.mv.db
is created in the working folder (that is, the directory where you run CodeScene).
You can override the default and provide a custom path through the environment variable CODESCENE_DB_PATH
.
Note that you need to specify a complete file name.
As an example, if you specify /User/Services/CodeScene/configuration
,
CodeScene will create a persistent database file named /User/Services/CodeScene/configuration.mv.db
.
Once you’ve launched the codescene.standalone.jar you just point your web browser to localhost:3003 to access CodeScene.
Configure the available Memory¶
RAM memory is a critical resource for CodeScene. In most cases 4G RAM is more than enough, but if your codebase has large files (we mean really large, like +30,000 lines of code) you may need more memory to run the X-Ray analyses.
Note that Java’s virtual machine has a system dependent maximum that is typically lower than the total RAM available. That means
you need to specify a higher threshold yourself when starting CodeScene. You do that by providing the -Xmx
flag to java.
Here’s an example that shows how to allocate 10 gigabyte of RAM for CodeScene:
java -Xmx10G -jar codescene.standalone.jar
Note that the order of the arguments matter in this case.
Run CodeScene in Tomcat¶
CodeScene is delivered as a WAR file (Web application ARchive). We recommend that you deploy it using Tomcat (https://tomcat.apache.org/index.html).
Specify a file folder for the database¶
CodeScene uses an embedded database. That means, you don’t have to install any database or drivers yourself. However, you need to specify a path to a file folder where CodeScene is allowed to store its database. Here’s how you configure Tomcat to do that:
- Open the file
context.xml
located under the conf directory in your Tomcat installation. - Add an
<Environment>
tag to context.xml that specifies the path to a folder you want to use for the database (see the example below). - Save context.xml.
Here’s an example on how context.xml may look on a Windows installation (note that you need to modify the path to fit your environment):
<Context>
<WatchedResource>WEB-INF/web.xml</WatchedResource>
<WatchedResource>${catalina.base}/conf/web.xml</WatchedResource>
<Environment name="empear.dbpath"
value="C:\\some\\path\\to\\the\\database\\empear.codescene"
type="java.lang.String"/>
</Context>
In case you run on a Linux-based system, you just specify a different path format. For example:
<Context>
<WatchedResource>WEB-INF/web.xml</WatchedResource>
<WatchedResource>${catalina.base}/conf/web.xml</WatchedResource>
<Environment name="empear.dbpath"
value="/Users/adam/Documents/Empear/deployment/empear.codescene"
type="java.lang.String"/>
</Context>
NOTE: Please ensure that Tomcat has write access to the folder you specify.
DB username and password¶
Optionally, you can specify a custom username and password to access the database. By default, CodeScene uses the ‘sa’ user with an empty password.
Add empear.dbuser
and empear.dbpassword
to the Context environment properties
to customize DB username/password.
Deploy the codescene.war¶
Once Tomcat is up and running, with your modified context.xml
, you just
copy the codescene.war
to the webapps folder in your Tomcat
installation.
Access CodeScene¶
By default, Tomcat will launch CodeScene on port 8080 and at the path /codescene/. If you’re logged in on the server, you access the application on http://localhost:8080/codescene/login. You should see the activation screen in your web browser (see Fig. 1).
Enter the credentials you received in your license file. You’re now ready to login (see Fig. 2).
The first time you login, you use the same credentials to login as you used to activate the application. That is, give your CodeScene Username as User Name and your CodeScene License Key as Password.
You’re now up and running with CodeScene!
Configure additional users¶
You are granted administration privileges each time you login with your license credentials (note that you can do that at any time, for example to administrate users).
You can add new users and assign them roles in the global configuration. Users and Roles describes this in greater detail.