GIF of the CLI in Action

A Railway project contains any plugins, environments, and deployments that an app needs. If you are logged in, projects can be found on your project dashboard.

All projects feature

  • 100 GB outbound network bandwidth
  • Ability to deploy multiple services
  • Unlimited inbound network bandwidth
  • Unlimited database services

Projects can contain one or multiple services to suit any application's architecture.

A new service can be spun up anywhere within the Project canvas.

Project Canvas

Screenshot of Project Canvas

The project canvas is the default view for a project. Within it, a user can manage services and environments or select a service to view its configuration.

Project Settings

Project specific settings can be managed through the button at the top right of the project canvas.

General Actions

A project's name and description can be changed through this tab. The project id can also be retrieved here.

Deleting Your Project

A project can be deleted by selecting the "Delete Project" button in the "Danger" tab. Deleting a project will delete all services, environments, and deployments associated with the project. Specific services within a project can also be deleted from this page.

Project Member Management

Screenshot of Project Team Members

Under the Members tab, members can be invited to access the project.

There are three scopes for project members

  • Owner: full administration of the project
  • Editor: Can create deployments, change project settings and add Editor and Viewer members.
  • Viewer: Read only access to the project. Viewers can not make deploys or see environment variables.

The Project Owner is charged for the project's usage.

Each project generates a project invite link. To invite someone via a link:

  1. Select the desired invited member scope
  2. Copy link and send to the invitee
Screenshot of Invite Links

Transferring Projects

Users can transfer projects to other users. Note that project transfers are only allowed for users subscribed to the Hobby Plan (both the initiator and recipient of the transfer).

In the member list under the members tab, select the three dots next to the user you want to transfer the project to.

Screenshot of Project Transfer Menu

The transferee receives an email with the current owner requesting to transfer the project to the user. Once that user accepts the transfer, they become the new owner of the project.

Project Activity Feed

Screenshot of Activity Pane

The activity feed displays a chronological feed of administrative actions performed within all or the current environment.

Currently, the activity feed tracks the following events.

  • Environment variable updates
  • Deployment status
  • Service creation/removal

The activity feed can be opened by clicking the tab at the lower right of the project canvas. On Mobile Screens, the activity button is placed at the top bar.

For now, the activity feed doesn't include the team member who performed the action. This is planned - track the request here.

CLI Instructions

Upon Project creation, a button on the lower left opens a modal with instructions to set up projects locally. After setup, the button can be dismissed by selecting Project setup is done. See our page on the CLI for more information.

Project Visibility

Private Projects

Projects are private by default. Private projects:

  • Are only accessible to members of the project

Public Projects

Screenshot of Project Visibility Setting

Public projects allow you to share your project in a read-only state with anyone on the internet.

Public visibility is helpful for educators who want to show students how their projects look before a user deploys their own.

  • Viewers don't need a Railway account to see the project
  • Environment variables are private from viewers
  • Services and Deployment logs are public

Edit this file on GitHub