Skip to main content

Webserver for webpublisher

note

This document is obsolete.

Running AYON webserver is needed as a backend part for Web publishing. Any OS supported by AYON could be used as a host server.

Webpublishing consists of two sides, Front end (FE) and AYON backend. This documentation is only targeted on OP side.

It is expected that FE and OP will live on two separate servers, FE publicly available, OP safely in customer network.

Requirements for servers

  • OP server allows access to its 8079 port for FE. (It is recommended to whitelist only FE IP.)
  • have shared folder for published resources (images, workfiles etc) on both servers

Prepare Ftrack

Current webpublish process expects authentication via Slack. It is expected that customer has users created on a Ftrack with same email addresses as on Slack. As some customer might have usernames different from emails, conversion from email to username is needed.

For this "ynput" user needs to be present on Ftrack, creation of this user should be standard part of Ftrack preparation for AYON. Next create API key on Ftrack, store this information temporarily as you won't have access to this key after creation.

Prepare AYON

Deploy OP build distribution (AYON Igniter) on an OS of your choice.

##Run webserver as a Linux service:

(This expects that OP Igniter is deployed to opt/ayon and log should be stored in /tmp/ayon.log)

  • create file sudo vi /opt/ayon/webpublisher_webserver.sh

  • paste content

#!/usr/bin/env bash
export AYON_DEBUG=3
export FTRACK_BOT_API_USER=YOUR_API_USER
export FTRACK_BOT_API_KEY=YOUR_API_KEY
export PYTHONDONTWRITEBYTECODE=1
export AYON_MONGO=YOUR_MONGODB_CONNECTION

pushd /opt/ayon
./openpype_console webpublisherwebserver --upload_dir YOUR_SHARED_FOLDER_ON_HOST  --executable /opt/ayon/openpype_console  --host YOUR_HOST_IP --port YOUR_HOST_PORT > /tmp/ayon.log 2>&1

  1. create service file sudo vi /etc/systemd/system/openpye-webserver.service

  2. paste content

[Unit]
Description=Run ayon Ftrack Webserver Service
After=network.target

[Service]
Type=idle
ExecStart=/opt/ayon/webpublisher_webserver.sh
Restart=on-failure
RestartSec=10s
StandardOutput=append:/tmp/ayon.log
StandardError=append:/tmp/ayon.log

[Install]
WantedBy=multi-user.target

  1. change file permission: sudo chmod 0755 /etc/systemd/system/ayon-webserver.service

  2. enable service: sudo systemctl enable ayon-webserver

  3. start service: sudo systemctl start ayon-webserver

  4. Check /tmp/ayon.log if OP got started

(Note: service could be restarted by service ayon-webserver restart - this will result in purge of current log file!)