Orion operator guide

What is Orion?

Orion is a backed node powering Atlas.

To learn how to run your own instance of Atlas, please refer to the Atlas operator guide.

All tutorials

• Running and testing Orion locally
• Gateway operator tasks:
  • Setting supported categories
  • Setting up App attribution
  • Managing maintenance mode
  • Changing configuration values
  • Accessing user reports
  • Excluding (censoring) content
  • Featuring content
  • Backing up Orion database
  • Configuring email notifications
• Production deployment:
  • Deploying Orion to production
  • Upgrading Orion

Orion architecture

Orion is actually a set of services, many of which are part of its underlying framework, Subsquid.

The description of each of those services can be found in the developer guide.

Running Orion instance

Running / testing locally

The easiest way to run the latest version of Orion locally is to use a joystream/orion docker image, which is automatically built and published to Docker Hub on each new Orion release.

You can find instructions on how to run Orion locally with Docker and test it together with Atlas in the Local testing tutorial.

To explore other ways of running Orion locally, which involve building the code from source, you can read Running local development instance tutorial from the developer guide.

Deploying to production

To learn how to deploy Orion to production, please read the Deployment tutorial.

Upgrading a production instance

The process of upgrading a production instance of Orion in the event of a new release is described in the Upgrading tutorial.