GIF of the CLI in Action

A Railway project contains all of your plugins, environments, and deployments. If you are logged in, all of your 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
  • Unique copy of your infra for each PR
  • Unlimited database services per project

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

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

Project Canvas

The project canvas is the default view for a project. Within it, you can perform administrative actions, view services, manage environments, select a service to view more information, and spin up new services.

Screenshot of Project Canvas

You can click and drag anywhere within the project canvas to focus on different areas of your infrastructure.

Project Settings

You can manage project specific settings under the Project Settings page accessible by the button on the top right in the project canvas.

General Actions

Under the Settings > General page you can change the project's name and description as well as retrieve the projectId.

Deleting Your Project

You can delete the project within the Settings > Danger page. Deleting a project will delete all running deploys of the service(s) within a project. Within this menu you may also delete any specific service.

Project Member Management

Screenshot of Project Team Members

Under the Members tab, you can invite members to access the project.

There are three scopes for project members

  • Owner: full administration of the project
  • Editor: administration and can make deployments to the project, sans the ability to remove the Owner from the project
  • Viewer: Read only access to the project. Viewers can not make deploys or see environment variables.

Only project owners are charged for project 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.

Under the members list in the members tab - click the 3 dots menu at the end of the user you'd like 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.

  • Variable upserts
  • 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 your project locally. After setup, you can dismiss the button entirely by pressing Project setup is done. See our page on the CLI for more information.

Project Visibility

Temporary Projects

Projects that are not created by a user that is logged in are considered temporary. These projects

  • Are destroyed 1 day after they are created
  • Are readable and writable by anyone
  • Can be claimed by any user to convert it into a private project

Private Projects

Projects that are created by a user that is logged in or that have been claimed are considered private. These projects

  • Are only accessible to members of the project
  • Are private and require permission to access

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