Skip to content

Remote Shell (Console Task)

You can easily open an ephemeral shell into your application using the console task.

This is provided by Remote SSH Docker Shell. You can then easily connect to your application using the Remote Shell Client.

Client Usage

$ remote-shell -a myapp
spawning remote shell...
root@container$ 

And you're in! Now you can run commands in your app's actual environment. When you exit, the container will be terminated, and all files written will be deleted. (Note: If you make database modifications, or external changes, those will still persist.)

You need to follow the Usage instructions for the RemoteShell app in order to add it to your application.

This is not a task that runs normally. Only a task definition is created, and the task will be run on-demand when you try to launch a shell. Once your session finishes, the task will be killed. Any modifications to the filesystem will be lost once you exit the shell. You cannot modify already deployed code.

Enabling Remote Shell

By default, the remote shell is not enabled. If you would like it to be created, you must explicitly enable it.

console: true
console:
  enabled: true
  port: 1234
console: false

Fields

enabled

Enables the Remote Shell. Obviously, this is required if you want the console.

Default: false (disabled by default)

port

Set the port that will be opened for this task.

Default: 8722

path

If you placed the RemoteShell binary in a non-standard location, then you should specify it here.

Default: not set (will use client default)

<anything from common>

See Common Task Options.

You can override things like cpu, memory or storage, etc