Managing Services

A Railway Service is a deployment target for your application.

As you create and manage your services, your changes will be collected in a set of staged changes that you must review and deploy, in order to apply them.

Creating A Service

Create a service by clicking the New button in the top right corner of your project canvas, or by typing new service from the command palette, accessible via CMD + K (Mac) or Ctrl + K(Windows).

GIF of the Services view

Services on Railway can be deployed from a GitHub repository, a local directory, or a Docker image.

Accessing Service Settings

To access a service's settings, simply click on the service tile from your project canvas and go to the Settings tab.

Defining a deployment source

If you've created an empty service, or would like to update the source for a deployed service, you can do so in the Service settings.

Click on the service, go to the Settings tab, and find the Service Source setting.

Screenshot of how to connect a service to a GitHub repo or Docker image

Deploying from a Github Repo

Define a GitHub repository as your service source by selecting Connect Repo and choosing the repository you'd like to deploy.

When a new commit is pushed to the linked branch, Railway will automatically build and deploy the new code.

Screenshot of a GitHub deployment trigger

You must link your Railway account to Github, to enable Railway to connect to your Github repositories. You can configure the Railway App in Github by clicking this link.

Deploying from a Docker Image

To deploy from a docker image, specify the path of the image when prompted in the creation flow.

Railway can deploy images from Docker Hub or GitHub Container Registry. Example paths -

Docker Hub:

  • bitnami/redis

GitHub Container Registry:

  • ghcr.io/railwayapp-templates/postgres-ssl:latest

Deploying from a local directory

Use the CLI to deploy a local directory to a service -

  1. Create an Empty Service by choosing Empty Service during the service creation flow.
  2. In a Terminal, navigate to the directory you would like to deploy.
  3. Link to your Railway project using the railway link CLI command.
  4. Deploy the directory using railway up. The CLI will prompt you to choose a service target, be sure to choose the empty service you created.

Deploying a Monorepo

For information on how to deploy a Monorepo click here.

Monitoring

Logs, metrics, and usage information is available for services and projects. Check out the monitoring guides for information on how to track this data.

Changing the Service Icon

Customize your project canvas for easier readability by changing the service icon.

  1. Right click on the service
  2. Choose Update Info
  3. Choose Icon
  4. Begin typing to see a list of available icons, pulled from our deviconsservice.

You can also access this configuration from the command palette.

Deleting a Service

Delete a service by opening the project's settings and scrolling to the danger section.


Edit this file on GitHub