Navigating AYON Server

This guide walks you through the AYON Server interface, focusing on the primary navigation points and their keyboard shortcuts.

Last updated 28 days ago

Overview

AYON Server provides multiple buttons and shortcuts to navigate the system quickly. The interface is primarily controlled via two main clusters of buttons located at the top of the Web UI:

Top Left (Production):

  1. Home

  2. Projects

Top Right (Management & Personal):

  1. User Avatar

  2. Main menu

  3. Inbox

  4. Help menu

  5. Chat bubble

In the following sections, we expand on the functionality of each area.

Additive Addons

Keep in mind that some addons may add more pages to your AYON Server.

For example, if you install the Planner Addon, you will see a new "Planner" tab appear inside your Home and Project pages.

Production Access

These buttons provide access to your daily production work.

  • Home (H + H): Your studio dashboard. Use this for a quick digest of tasks and to see general information about active projects. For more info, see Tasks (Home) Page

  • Projects (1): The production hub. This is where you enter a specific project to manage folders, assignments, products, and review work. For more info, see Project Overview Page and Products and Versions Page.

App Menu

Clicking the app menu (grid of dots) at the top next to your profile image opens the main panel. App Menu items can be seen as two groups:

Configuration

  • Studio Settings (S + S): Global rules. Changes here affect every project in your studio. For more info, see Working with settings.

  • Project Settings (P + P): Project-specific overrides for custom workflows. For more info, see Working with settings.

  • Market (M + M): Browse and install new addons to extend your server's capabilities. For more info, see AYON Market

System

  • Event Viewer (E + E): The server's "Black Box." Check here for logs and to troubleshoot issues.

  • Services (V + V): Monitor the health of background AYON workers. For more info, see AYON Services.

  • Server Actions: From here, you can also trigger a Pipeline Update or Restart the Server. For more info, see Updating Pipeline to latest Release.

Communication & User

These icons handle your personal experience and notifications.

  • Inbox: Where you find notifications and mentions. For more info, see Inbox and Notifications

  • User Avatar button:

    • Account: Modify your profile, manage active Sessions, or find your Launchers.

    • Download Launcher: A direct shortcut to the launcher downloads page.

    • Sign Out (0 + 0): End your current session.

  • Chat Bubble: Opens the AYON AI assistant for help with documentation.

Help Menu

The ? icon contains essential resources for technical users:

  • REST API: Opens a dynamic documentation page. This is unique to your server; it includes endpoints for all addons currently in your Production Bundle.

  • GraphQL Explorer: An interactive playground to query the AYON database directly.

  • Community: Quick links to the Documentation, Discord, Forums, and Feedback portal.

Tips

AYON Shortcuts

For a complete list of AYON Shortcuts, go to AYON Web App Keyboard Shortcuts.

If you are ever lost, remember these essential shortcuts:

  1. Production (1): Go to project-specific folders and reviews.

  2. Admin (S+S, P+P, E+E, B+B): Manage settings, bundles, and server logs.

  3. Overview (H+H): Return to the studio-wide dashboard.

FAQ

How to show the version of AYON Server?

To show the the version of your server, follow the following steps:

  1. Click AYON Main menu on top right

  2. You’ll be able to find the version of AYON server.

The server version is usually a two numbers separated by a plus sign that represents backend version + frontend version e.g. 1.13.4+202512041544 shows that server is on backend version 1.13.4 and frontend version on 202512041544.