Access running containers locally | Run | Northflank Application docs

Run /

Access running containers locally

You can forward your deployment and addons for local development, this allows you to access resources as if you were in your secure Northflank project network.

You can also open a shell in your running containers, giving you SSH-like access to the filesystem, environment, and processes.

Forward containers for local access

You can forward a deployment for local development and access using the Northflank CLI.

Your deployment must be running and have at least one port configured.

You can view and copy the command to connect to a deployment on the specific deployment's overview, in the local access section, or use the following commands:

  • To forward a specific service:

    sudo northflank forward service --projectId [project-name] --serviceId [service-name]
  • To forward all ports in a project:

    sudo northflank forward all --projectId [project-name]

You can now connect to your deployment locally on the available ports.

Execute commands in a container

Shell access gives you access to everything inside your container, such as environment, filesystem, processes, and the ability to run commands like top, npm, sed, vi, df. It also provides command completion and command history where possible.

You can access the shell of running containers in deployment and combined services by navigating to the containers page for the specific service. You can open a shell for a specific container by clicking shell access button.

Running job containers can be accessed by navigating to the job runs page and selecting an active job run. Click shell access button on the specific container to open a shell.

Accessing a container shell in the Northflank application

Copy & paste

You can copy and paste in the browser shell with control-shift-c and control-shift-v. This may not work in Firefox, where you may need to use the right-click menu to copy and paste. Command-c and command-v works across all browsers on macOS.