Automa publishes official Railway 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 to get started. Once you have an account, go to the Automa template and deploy it by clicking on the “Deploy Now” button.

​
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.

​
Configuring integrations

Automa supports various third-party integrations like GitHub, Linear, and Jira. 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:

GitHub

Configure GitHub to allow users to provide access to their repositories, and creating tasks from issues and pull requests.

Linear

Configure Linear to allow users to create tasks from issues.

Jira

Configure Jira to allow users to create tasks from issues.

​
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.

​
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.