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.
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).
Services on Railway can be deployed from a GitHub repository, a local directory, or a Docker image.
To access a service's settings, simply click on the service tile from your project canvas and go to the Settings tab.
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.
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.
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.
To deploy from a docker image, specify the path of the image when prompted in the creation flow.
GitHub Container Registry:
Use the CLI to deploy a local directory to a service -
- Create an Empty Service by choosing
Empty Serviceduring the service creation flow.
- In a Terminal, navigate to the directory you would like to deploy.
- Link to your Railway project using the
railway linkCLI command.
- 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.
For information on how to deploy a Monorepo click here.
Logs, metrics, and usage information is available for services and projects. Check out the monitoring guides for information on how to track this data.
Customize your project canvas for easier readability by changing the service icon.
- Right click on the service
- Begin typing to see a list of available icons, pulled from our deviconsservice.
You can also access this configuration from the command palette.
Delete a service by opening the project's settings and scrolling to the danger section.
Edit this file on GitHub