> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automa.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Railway

> A step-by-step guide to setting up Automa using Railway templates

Automa publishes official [Railway](https://railway.com) templates for the whole application. This section will help you set it up using Railway.

## Setting up

There are 3 steps in the setup process:

* Start the needed services.
* Check if the services are working.
* Configure third-party integrations.

### Start services

You will need an account on [Railway](https://railway.com) to get started. Once you have an account, go to the [Automa template](https://railway.com/deploy/PKfjlB?referralCode=Ri3kTG) and deploy it by clicking on the "**Deploy Now**" button.

<video autoPlay muted loop playsInline className="mx-auto rounded-xl" src="https://mintcdn.com/automa/eeL4keyWWsKr0LQB/videos/self-hosting/railway-deploy.mp4?fit=max&auto=format&n=eeL4keyWWsKr0LQB&q=85&s=cb9b4ed11a3ba902e499a22d44f00635" data-path="videos/self-hosting/railway-deploy.mp4" />

### Check the setup

If you have successfully deployed the template, you should see 4 healthy services in your Railway project: **API**, **Console**, **Postgres**, and **Redis**.

The **Console** service in the Railway project should have been automatically assigned a domain name by Railway in the form of `<random>.up.railway.app`. You can find this by clicking on the service, and if you visit this domain in your browser, you should see the **Automa Console** interface.

<video autoPlay muted loop playsInline className="mx-auto w-3/4 rounded-xl" src="https://mintcdn.com/automa/eeL4keyWWsKr0LQB/videos/self-hosting/railway-domain.mp4?fit=max&auto=format&n=eeL4keyWWsKr0LQB&q=85&s=ce65babf04e5c913471a38d6c85b842c" data-path="videos/self-hosting/railway-domain.mp4" />

### Configuring integrations

Automa supports various third-party integrations like [GitHub](https://github.com), [Linear](https://linear.app), and [Jira](https://jira.com). Most of these integrations require you to set up OAuth applications on the respective platforms and provide the necessary credentials to the **Automa API** service.

You can find detailed instructions for each integration in the respective documentation pages:

<Columns cols={2}>
  <Card arrow title="GitHub" href="/self-hosting/integrations/github">
    Configure GitHub to allow users to provide access to their repositories, and
    creating tasks from issues and pull requests.
  </Card>

  <Card arrow title="Linear" href="/self-hosting/integrations/linear">
    Configure Linear to allow users to create tasks from issues.
  </Card>

  <Card arrow title="Jira" href="/self-hosting/integrations/jira">
    Configure Jira to allow users to create tasks from issues.
  </Card>
</Columns>

#### Adding environment variables

When you are configuring third-party integrations, you will need to add environment variables to the **API** service in the Railway project.

For example, to add a Jira integration, go to the **API** service in your Railway project, click on the "**Variables**" tab, and add the new environment variables.

<video autoPlay muted loop playsInline className="mx-auto rounded-xl" src="https://mintcdn.com/automa/eeL4keyWWsKr0LQB/videos/self-hosting/railway-env-var.mp4?fit=max&auto=format&n=eeL4keyWWsKr0LQB&q=85&s=f02440811d3d5559f7908c91b473f4b3" data-path="videos/self-hosting/railway-env-var.mp4" />

## Updating

We recommend updating periodically to ensure you have the latest features and security updates. To update your **API** and **Console** services, go to each service in your Railway project, click on the "**Deployments**" tab, click on **three dots** on active deployment, and then choose the "**Redeploy**" option. This will pull the latest changes and redeploy your service.

<video autoPlay muted loop playsInline className="mx-auto rounded-xl" src="https://mintcdn.com/automa/eeL4keyWWsKr0LQB/videos/self-hosting/railway-redeploy.mp4?fit=max&auto=format&n=eeL4keyWWsKr0LQB&q=85&s=28b410a04aaa543185c129b618f51f0f" data-path="videos/self-hosting/railway-redeploy.mp4" />
