Documentation
Software Delivery Automation
CloudBees Software Delivery Automation CloudBees CI CloudBees CD/RO CloudBees Previews
Other CloudBees Products
CloudBees Build Acceleration CloudBees CodeShip
Cloud-Native Platform
CloudBees platform CloudBees Feature Management (legacy)
Resources
Account management Legal and policies
Training
Support
Plugins
CloudBees CI Plugins CloudBees CD/RO Plugins
Lexicon
CloudBees CI CloudBees CD/RO CloudBees platform CloudBees Feature Management (legacy)CloudBees Build Acceleration
AI HelpBeta
Search
Enable dark mode
New to CloudBees or returning.
Sign in / Sign up

Resources

Account management Legal and policies

Software Delivery Automation

CloudBees Software Delivery Automation CloudBees CI CloudBees CD/RO CloudBees Previews

Cloud-Native Platform

CloudBees platform CloudBees Compliance CloudBees Feature Management (legacy)

Other CloudBees Products

CloudBees Build Acceleration CloudBees CodeShip

Documentation Changelog

Introduction Getting started with CI & CD SCM Support Configuring GitHub Configuring Bitbucket Configuring GitLab Required permissions for remote SCMs VM & infrastructure specifics Two-Factor authentication Security information GDPR compliance CI & CD for mobile Self-hosted SCM

Introduction New user signup Organization accounts Summary report Connected services Notifications Static IP addresses Delete user account Invoices Heroku accounts

Introduction Creating new projects SSH public key Skipping individual builds Configuring build triggers Git remote push Builds not starting

Getting started

Introduction Installed packages Environment variables Debugging builds Caching Parallel testing Deployment pipelines Running commands as root Ignoring commands Run a command in case of an error Setting timezone Access to other repositories Using scripts Git LFS Ubuntu 20.04 Focal

Introduction FTP/SSH/SFTP/RSYNC Custom script Heroku Heroku Migration AWS Elastic Beanstalk AWS CodeDeploy AWS Lambda AWS S3 Google App Engine AWS CLI gcloud CLI Azure CLI Digital Ocean Engine Yard Capistrano Git Push CloudFoundry Cloud66 anynines

Introduction Browser testing Background commands Git submodules Custom DNS Artifacts

Introduction Cassandra CouchDB DynamoDB MongoDB MySQL PostgreSQL SQLite

Introduction Dart Elixir Go Java and JVM Meteor Node.js PHP Python Ruby Rust

Introduction Beanstalkd RabbitMQ Redis

Introduction Elasticsearch Memcached Sphinx

Introduction CloudBees CodeShip Pro introduction guide CloudBees CodeShip Pro introduction guide 2 CloudBees CodeShip Pro introduction guide 3 CloudBees CodeShip Pro introduction guide 4 CloudBees CodeShip Pro introduction guide 5

Migrating to CloudBees CodeShip Pro

Docker for CI/CD

Getting started with CloudBees CodeShip Pro overview and resources

Introduction Services config Steps config Environment variables Image registries Image caching Build arguments Volumes Handling secrets Multiple repos Services and databases Setting an SSH private key Preinstalled images

Introduction Installation Using the Jet CLI jet cleanup jet decrypt jet encrypt jet generate jet load jet run jet steps jet update jet validate jet version

Introduction AWS AWS S3 AWS EB AWS ECS AWS EKS AWS CodeDeploy Azure Container Service Heroku Google Cloud Google App Engine Google Cloud Functions Google Container Engine Google Compute Engine Kubernetes Terraform Deploy Via SSH Docker Swarm IBM Cloud Foundry IBM Cloud Container Service

Introduction Browser testing Parallel testing

Introduction Elixir Go Java and JVM Node.js PHP Python Ruby

Introduction Caching multi-stage Dockerfile Container is slow to exit Differing results with Jet CLI Docker Hub rate limiting Managing multiple environments for a service Reducing log output from dependent containers Step log not appearing Using env vars in command steps

Using CodeShip API

Using Assertible

Using Codeclimate

Using Coveralls

Custom integrations

Using Ghost Inspector

Using Honeycomb

Using PagerDuty

Using RedLine13

Introduction Basic vs. Pro Locating UUIDs Rate limiting Pagination Errors API clients

Introduction POST authenticate

Introduction POST create project GET get project PUT update project GET list projects POST create test pipeline GET get test pipeline PUT update test pipeline POST create deploy pipeline GET get deploy pipeline PUT update deploy pipeline POST reset AES key

Introduction POST create build GET get build GET list builds GET build pipelines POST stop build POST restart build GET get build services GET get build steps

Executive Summary

Unify Product Overview

Migration to Unify Strategy

Support and Additional Resources

Customer Success Stories

Frequently Asked Questions

Inventory of CodeShip Projects

Onboard Organization & Teams

Connect Source Code Management (SCM)

Introduction Environments Environment Variables Properties

Configure Notifications

Create Components for Projects

Introduction Pipeline Steps Test and Deploy Scripts Permissions ECR and Private Images Feature Map Example Pipeline to Workflow

Access Build/Workflow Run Data

Access Test Results

Troubleshooting

Cutover and Deprovisioning CodeShip

Add a Payment Method to CloudBees Unify

Sphinx

1 minute read

Sphinx can be installed and run on Basic with the following steps:

sudo apt-get update

sudo apt-get install -y sphinxsearch▼

© CloudBees, Inc. 2010 - 2025

Privacy Policy|Legal Notices|Security