Deployment prerequisites

To run CodeScene as a standalone application, you need the following:

• A Java JDK, 64-bit, version 17 or later. You ensure you have the right Java version by typing java -version in a command prompt.
  
• A Git client on your path. Your Git client has to be at least version 2.32. You ensure you have the right Git client version by typing git --version in a command prompt.
  
• SSH client for use with Git when accessing repositories protected by a pair of public/private key.
  

Video walkthrough

▶️ See this video for a complete walkthrough of  deploying CodeScene using an executable JAR file.

Deployment instructions

Follow the steps below to deploy CodeScene locally:

1. Download CodeScene

• To start using CodeScene, download executable JAR file ↗ first.

2. Start CodeScene

• Navigate to the folder where JAR file is downloaded.
  
• To start CodeScene, open Terminal and launch the standalone JAR from the command line:

java -jar codescene-enterprise-edition.standalone.jar

3. Create an SSH key

• To generate a new SSH key, paste the command below and substitute your Git email address:
  

ssh-keygen -t ed25519 -C "your_email@example.com"

• When you are prompted to "Enter a file in which to save the key," press Enter to accept the default file location.
  

> Enter a file in which to save the key (/Users/YOU/.ssh/id_ed25519_sk): [Press enter]

• When you are prompted to type a passphrase, press Enter for no passphrase:
  

• To display the public SSH key, paste the command below:
  

ssh-keygen -y -t ed25519

• Add the SSH authentication key with read access to your account on Git provider. For more information on how to add an SSH key to your account, read GitHub documentation or refer to your Git provider’s specific documentation.

4. Activate CodeScene

• If you deployed on your local machine, go to localhost:3003 and choose “Start Free Trial” option.
  
• If you deployed to a remote server, use the server's hostname instead of localhost.
  
• After you click ”Start Free Trial”, you’ll be asked to create an account.

Need support?

• See detailed deployment requirements and full deployment instructions for more information.
  
• See this video for a complete walkthrough of deploying CodeScene using an executable JAR file.
  
• If you’re facing an unexpected issue or application behavior, you can use detailed analysis diagnostics and logs to gather more data or reach out to CodeScene Support.