Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User Docs - Getting Started - changes made for up to date info and improvement #189

Merged
merged 1 commit into from
Jun 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 22 additions & 19 deletions website/docs/artist_getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,19 @@ import TabItem from '@theme/TabItem';

## Installation

AYON comes in packages for Windows (10 or Server), Mac OS X (Mojave or higher), and Linux distribution (Centos, Ubuntu).
**AYON** and its installation files are available for all major operating systems: **Windows** 10 (Server, WIN 11 and newer), **macOS** (Mojave or later), and **Linux distributions (Rocky Linux, Ubuntu and formerly CentOS).
LiborBatek marked this conversation as resolved.
Show resolved Hide resolved

Besides getting AYON installation files from Github you also have option to get those via `AYON server` webUI in the `Studio Settings` section.


In AYON you can download the installer from within the website:
![A screenshot of the AYON main menu with the "Download Launcher" menu expanded](assets/ayon_download_installer.png)

A "Download Launcher" blue button should be present, which provides a binary for the Operating System you are accessing the webistes, alternatively you can download a specific binary from the dropdown in the main menu.
A `Download Launcher` button should be present, which provides a binary for the Operating System you are accessing the server website, alternatively you can download a specific binary from the dropdown in the main menu.

If you are testing or working by yourself, you can also grab installation files from the releases: https://github.com/ynput/ayon-launcher/releases

:::important
To install AYON you will need administrator permissions.
:::important User Permissions
To install **AYON** on your machine you will need **admin user account rights** to do so.
:::

:::note pick your platform
Expand Down Expand Up @@ -72,44 +74,45 @@ After the installation, you can find AYON among the other Applications.

## Working in the studio

In studio environment you should have AYON already installed and deployed, so you can start using it without much setup. Your admin has probably put AYON icon on your desktop or even had your computer set up so AYON will start automatically.
Ensure AYON is installed and deployed in your studio environment for immediate use. Your admin likely placed the AYON icon on your desktop or configured your system to launch AYON upon startup.

![AYON Launcher Icon](assets/ayon_launcher_icon.png)

If this is not the case, please contact your administrator to consult on how to launch AYON in your studio.
If this is not the case, reach out to your administrator for guidance on deploying AYON in your studio.

## Working from home
## Working remotely

If you are working from home though, you'll need to install it yourself. You should, however, receive the AYON installer files from your studio
administrator, because AYON versions and executables might not be compatible between studios.
If you are working remotely e.g. from home, you'll need to install the AYON Launcher by yourself. You should, however, receive the AYON installer files from your studio administrator, because AYON versions and executables might not be compatible between sites.

Installing AYON is possible by using the Installer or by unzipping downloaded ZIP archive to any drive location.

:::tip Using the AYON Installer
See the [Installation section](#installation) for more information on how to use the AYON Installer
:::tip
See the [Installation section](#installation) for more information on how to use the **AYON Installer**
:::

You can run AYON by desktop "P" icon (if it exists after installing) or by directly executing **ayon_gui.exe** located in the AYON installation folder. This executable being suitable **for artists**, or alternatively by **ayon_console.exe** which is more suitable for **TDs/Admin** for debugging and error reporting. The later runs with a console window where all the necessary info will appear during user's work session.
You can run AYON by desktop "AYON" green triangle icon (if it exists after installing) or by directly executing **ayon_gui.exe** located in the AYON installation folder. This executable being suitable **for artists**, or alternatively by **ayon_console.exe** which is more suitable for **TDs/Admin** for debugging and error reporting. The later runs with a console window where all the necessary info will appear during user's work session.

:::tip Is AYON running?
AYON runs in the operating system's tray. If you see a green AYON icon in the tray you can easily tell AYON is currently running. Keep in mind that on Windows this icon might be hidden by default, in which case, the artist can simply drag the icon down to the tray.
:::

![A screenshot of the Windows System Tray showing the AYON icon](assets/artist_systray.png)
:::

:::tip Icon not showing on Linux
:::tip Linux / missing AYON icon
Some Linux distributions do not ship with tray icons by defaults, mostly GNOME based, to get the icon, install the following extension: [Appindicator Support for GNOME Shell](https://extensions.gnome.org/extension/615/appindicator-support/)
:::

## First Launch

When you first start AYON, you will be asked to fill in some basic information.
Upon launching AYON, you'll be prompted to enter your credentials to login to the AYON server and its URL.

![A screenshot of the AYON login dialog](assets/artist_login.png)

### AYON Login Details

Your Studio should provide you with the AYON `url`, `username` and `password` to fill in the dialog.

:::tip Example details
:::tip Example
URL: `https://mystudio.ayon.app/`
username: `johndoe`
password: `v3ry53cur3p455w0rd`
Expand All @@ -118,8 +121,8 @@ password: `v3ry53cur3p455w0rd`

## Updates

AYON updates automatically, based on your studio server, every time you launch it; that's why on first time launch it might do a new installation, if your Studio is using a more recent version, even though you might have just installed it.
**AYON** updates automatically, based on your studio server every time you start AYON Launcher on your machine. Upon initial launch, the software may perform a fresh installation to ensure compatibility with the latest version of Studio, even if you recently installed it.

## Advanced Usage

For more advanced use of AYON commands please visit [Admin section](admin_launcher_run#arguments).
For more advanced usage of **AYON Launcher** app, like running with console, staging, or develop mode, please visit [Admin section](admin_launcher_run#arguments).
Binary file modified website/docs/assets/artist_systray.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/docs/assets/ayon_install_windows_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified website/docs/assets/ayon_install_windows_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/docs/assets/ayon_launcher_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading