How to deploy CodeScene On-prem

There are two recommended options for installing CodeScene:

• Deploy CodeScene using Docker
• Deploy CodeScene using executable JAR file

Deploy CodeScene using Docker

Deployment prerequisites

Before proceeding, make sure you have Docker installed on your desktop. If you don't have Docker installed, follow the installment instructions for Mac, Windows or Linux.

Deployment instructions

Follow the steps below to deploy CodeScene locally:

1. Start CodeScene

• Run docker run to start CodeScene (in this case with /codescene bound to a subdirectory):

2. Create an SSH key

• Run docker exec -it -u codescene codescene ssh-keygen to generate an SSH key inside the container with no passphrase.
• Run docker exec -it -u codescene codescene ssh-keygen -y to display the public SSH key.
• Add that key to a user on your repository provider with read access to your repositories.
  

3.  Activate CodeScene

• If you deployed locally, go to http://localhost:3003 and click “Start Free Trial”.
• 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.

Deploy CodeScene using executable JAR file

Deployment prerequisites

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

•  A Java JDK, 64-bit version, at least Java 11 (we recommend Java 17+). You ensure you have the correct 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 keys.

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

• You can start CodeScene by launching the standalone JAR from the downloaded file, by entering this command line java -jar codescene-enterprise-edition.standalone.jar. 

3. Create an SSH key

• Run ssh-keygen to generate an SSH key with no passphrase.
• Run ssh-keygen -y to display the public SSH key.
• Add that key to a user on your repository provider with read access to your repositories.

4.  Activate CodeScene

• If you deployed on your local machine, go to http://localhost:3003 and click “Start Free Trial”.
• 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.