Classic Docs
Docs Navigation

SSH access to build environment

Semaphore allows you to interactively access your project’s build environment through an SSH session. Launching an SSH session allows you to troubleshoot build failures, explore the platform and helps you configure projects with specific needs quickly.

After your build or deploy is finished, Semaphore lets you start an identical build environment where you can run your build commands. All in the comfort of your terminal.

# Requirements

In order to use Semaphore's SSH session, you'll need to add a public SSH key to your account settings.

# Launching a new SSH session

To launch such a debugging environment, click on the Launch SSH button, found after opening the particular job's log.

When the popover appears click on the Launch Session button, this will enqueue and prepare your session.

Semaphore will start a build environment identical to the one where your current build or deploy ran. Your project’s Git repository will be checked out at the same revision. Semaphore will also export any configuration files and environment variables which you have configured in your project's settings.

When the session is ready you will receive a command with which you can ssh into your build server.

# Closing an SSH session

An SSH session will be open for 60 minutes after which it will close automatically. To close the SSH session manually you can either close it from the build or deploy page where it was activated or to trigger a shutdown from the console.

To close the session from the console, execute the following command in the SSH session:

sudo poweroff

# Tip: rsync files into an SSH session

Take note of your assigned IP address and port, and run rsync with the following command options:

rsync -avz -e "ssh -p <port>" testfile runner@<ip-address>:somefile

Semaphore Docs are open source — Edit on GitHub


Occasional lightweight product and blog updates. Unsubscribe at any time.

2009-2020 © Rendered Text. All rights reserved. Terms of Service, Privacy policy, Security.