CodeTogether On-Premises Installation Guide

Roll out CodeTogether internally and keep your source 100% behind your firewall. To use CodeTogether On-Premises, pull down and configure the CodeTogether On-Premises container. The container provides a full set of collaboration services, including tailored client plugins for the host IDEs.

Installing CodeTogether

Follow these steps to install CodeTogether On-Premises:

  1. Contact Genuitec Customer Service to obtain your license and registry credentials.
  2. Set up your container. Select the deployment technology below for detailed instructions.
    Note: If using single sign-on integration, refer to Single Sign-On (SSO) Support for configuration steps and environment variables that must be configured in the container.
  3. Refer to CodeTogether Edge Server Technical Notes for advanced configuration and troubleshooting steps, including how to configure load balancers and access log files.
  4. Download pre-configured plugins and extensions for your IDEs from your on-premises server. These will be automatically updated when you update CodeTogether.
  5. Use the metrics dashboard for access to real-time information and historical usage trends. Refer to Using the On-Premises Dashboard for more information.

Setting Up Your Container

Select the deployment technology you would like to use:

Docker Container

Deploy via Docker, using the Genuitec Docker Registry or Red Hat Software Catalog.

Helm Chart

Deploy as a Kubernetes pod through a Helm chart.

Kubernetes

Deploy as a Kubernetes pod through a deployment file.

Red Hat OpenShift

Deploy as an OpenShift pod using the Red Hat Software Catalog.

Security

Due to security requirements, all communication in CodeTogether is required to be done via TLS, in addition to end-to-end encryption at the application layer. Besides strictly following secure coding practices, every CodeTogether build is scanned using vulnerability checking tools like Snyk and Trivy. Penetration tests are frequently run on our container, ensuring that it is not susceptible to vulnerabilities and attacks. We build on the Red Hat UBI minimal image and our security audited listing can be found in the Red Hat Software Catalog.

Additional Resources

If you have any questions, email support@genuitec.com or contact your Genuitec Sales representative. You can also visit our Gitter community.

For answers to common questions, refer to the On-Premises FAQ.