AWS deadline-cloud documentation change
Summary
Major restructuring and expansion of Adobe After Effects documentation including detailed installation instructions, troubleshooting section, font attachment system explanation, job submission workflow, and configuration settings.
Security assessment
The changes focus on installation procedures, configuration steps, and workflow improvements without addressing security vulnerabilities or weaknesses. The addition of script permission requirements ('Allow Scripts To Write Files And Access Network') is a standard operational configuration for After Effects functionality, not a security fix or vulnerability mitigation. No evidence of security patches, vulnerability disclosures, or incident responses exists in the diff.
Diff
diff --git a/deadline-cloud/latest/userguide/adobe-after-effects.md b/deadline-cloud/latest/userguide/adobe-after-effects.md index e68b15d08..fc32980d5 100644 --- a//deadline-cloud/latest/userguide/adobe-after-effects.md +++ b//deadline-cloud/latest/userguide/adobe-after-effects.md @@ -7 +7 @@ -Support overviewAfter Effects version compatibilityDeadline Cloud Conda ChannelGetting startedUsing the After Effects submitterAdvanced configurationsOpen source resources +Support overviewAfter Effects version compatibilityDeadline Cloud Conda ChannelGetting startedInstallationUsing the After Effects submitterTroubleshootingAdvanced configurationsOpen source resources @@ -11,5 +11 @@ Support overviewAfter Effects version compatibilityDeadline Cloud Conda ChannelG -###### Note - -For more information about installing, configuring, and using this integration on your workstation, see the [After Effects integration user guide on GitHub](https://aws-deadline.github.io/after-effects/). - -Adobe After Effects is a professional digital visual effects, motion graphics, and compositing application. After Effects is fully supported by Deadline Cloud with comprehensive integration including submitters and conda packages for increased rendering performance. +Adobe After Effects is a professional digital visual effects, motion graphics, and compositing application. After Effects is fully supported by Deadline Cloud with comprehensive integration including submitters and conda packages for increased rendering performance. This guide provides step-by-step instructions for using AWS Deadline Cloud with After Effects to render your projects faster by distributing rendering tasks across multiple machines. @@ -66 +62 @@ Complete the following steps to set up After Effects with Deadline Cloud. You wi - * macOS: ` /Users/<user>/DeadlineCloudSubmitter/Submitters/AfterEffects/AE<version>` + * macOS: ` /Users/<user>/Library/Preferences/Adobe/After Effects/<version>/Scripts/ScriptUI Panels` @@ -74,0 +71,130 @@ Complete the following steps to set up After Effects with Deadline Cloud. You wi +## Installation + +To install the Deadline Cloud submitter for After Effects, prepare the following environment: + + * Windows or macOS workstation. + + * Adobe After Effects 24, 25, or 26 installation. + + * Python 3.9 or higher. + + * Access to an Deadline Cloud farm with either: + + * A service-managed fleet with After Effects available (via custom conda package). + + * A customer-managed fleet with After Effects and licensing set up. + + + + +### Prerequisites + +Before installing the submitter, complete the following steps: + + 1. Install the Deadline Cloud CLI and Deadline Cloud monitor by running the Deadline Cloud submitter and monitor installers from the downloads section of the Deadline Cloud service in your AWS console. + + 2. Enable script permissions in After Effects. The submitter requires the ability to write files and send communication over the network to function properly. By default, After Effects scripts are not allowed to perform these actions. For more information, see [Adobe's scripts reference](https://helpx.adobe.com/after-effects/using/scripts.html). + +To allow scripts to write files or send communication over a network, complete the steps for your operating system: + + * **Windows** : Choose **Edit** > **Preferences** > **Scripting & Expressions** > select **Allow Scripts To Write Files And Access Network**. + + * **macOS** : Choose **After Effects** > **Settings** > **Scripting & Expressions** > select **Allow Scripts To Write Files And Access Network**. + + + + +### Installing the submitter + +The After Effects submitter extension allows you to submit jobs to Deadline Cloud directly from within After Effects. + +###### Note + +During the installer process, you choose between User Install or System Install. macOS users default to User Install, because automatic System Install is currently not supported on macOS (manual System Install is still possible for admin users). Read only the section below that matches your selection. + +#### User install + + 1. Download the Deadline Cloud submitter installer by following [Step 1: Install the Deadline Cloud Submitter](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/submitter.html#submitter-installation). + + 2. Run the installer (no admin required). + + 3. Follow the prompts and select the After Effects submitter and choose the major version (for example, 24, 25, or 26). + + 4. The submitter is installed based on your operating system: + + * **macOS** : The installer automatically places `DeadlineCloudSubmitter(User).jsx` and `DeadlineCloudSubmitter_Assets` into your After Effects user preferences directory for all minor versions of the selected major version: + + /Users/<user>/Library/Preferences/Adobe/After Effects/<version>/Scripts/ScriptUI Panels + +The submitter appears in the **Window** menu in After Effects. + + * **Windows** : The submitter is installed to a standalone location by default: + + C:\Users\<user>\DeadlineCloudSubmitter\Submitters\AfterEffects\AE<version> + +You will need to run the script manually using **File** > **Scripts** > **Run Script File**. + + + + +#### System install + +###### Note + +Automatic macOS system install is not yet supported by the submitter installer. macOS admin users can perform a manual system install by copying files to the application directory (see Manual installation (alternative)). + + 1. Download the Deadline Cloud submitter installer by following [Step 1: Install the Deadline Cloud Submitter](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/submitter.html#submitter-installation). + + 2. **Windows only** : Right-click the installer and choose **Run as Admin**. + + 3. Follow the prompts and select the After Effects submitter. It is installed to: + + * **Windows** : `C:\Program Files\Adobe\Adobe After Effects <version>\Support Files\Scripts\Script UI Panels` + + * **macOS** (manual): `/Applications/Adobe After Effects <version>/Scripts/ScriptUI Panels` + + + + +#### Final setup steps + + 1. After installing using the submitter installer, ensure you log into your Deadline Cloud user profile by running `deadline auth login` in the Terminal/PowerShell or logging in using Deadline Cloud monitor. + + 2. To install the necessary dependencies used by the After Effects submitter, run the following in your local Terminal or Command Prompt: + + pip install fonttools + + 3. Restart After Effects if it was open. + + + + +#### Manual installation (alternative) + +If you prefer to install manually, you can copy the submitter files directly: + + 1. Locate the `DeadlineCloudSubmitter.jsx` file and the `DeadlineCloudSubmitter_Assets` folder in the `dist` folder of the [deadline-cloud-for-after-effects repository](https://github.com/aws-deadline/deadline-cloud-for-after-effects). + + 2. Copy both to the **ScriptUI Panels** folder within your After Effects installation: + + * **Windows** : `Program Files\Adobe\Adobe After Effects <version>\Support Files\Scripts\Script UI Panels` + + * **macOS** : `Applications/Adobe After Effects <version>/Scripts/Script UI Panels` + + 3. Restart After Effects if it was open. + + + + +#### Setting up After Effects with your Deadline Cloud farm + +After Effects conda packages are available in Deadline Cloud service-managed fleets. For the list of supported versions, see the [Deadline Cloud user guide](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/create-queue-environment.html). If you want to build a conda channel that contains a different After Effects conda package, follow the [instructions for creating custom conda channels](https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/configure-jobs-s3-channel.html). + +You can also use the After Effects conda recipe in the [deadline-cloud-samples package](https://github.com/aws-deadline/deadline-cloud-samples/tree/mainline/conda_recipes/aftereffects-25.1) as a reference when building the package. + +Jobs created by this submitter require the `aerender` executable to be available on the PATH of the user that runs your jobs. Alternatively, you can set the `AERENDER_EXECUTABLE` environment variable to point to the aerender executable. + +#### Updating the submitter + +To update the submitter to the latest version, download and run the latest submitter installer. + @@ -77 +203,7 @@ Complete the following steps to set up After Effects with Deadline Cloud. You wi -### Launching the submitter +To use the Deadline Cloud submitter for After Effects, ensure your farm is configured with an After Effects-capable fleet (see Setting up After Effects with your Deadline Cloud farm) and have the submitter installed. Log into Deadline Cloud monitor or provide AWS credentials using a configuration profile for Deadline Cloud access. + +### Submit a job + +###### Note + +Follow the instructions below that match the install type you selected during installation. @@ -79 +211 @@ Complete the following steps to set up After Effects with Deadline Cloud. You wi -###### To launch the After Effects submitter +#### User install - macOS @@ -83 +215,63 @@ Complete the following steps to set up After Effects with Deadline Cloud. You wi - 2. Update the following settings within After Effects to allow scripts to write files and send communication over a network: + 2. Open the submitter by choosing **Window** > **DeadlineCloudSubmitter(User).jsx**. + + 3. Follow the steps in Submitting your job below. + + + + +#### User install - Windows + + 1. Launch Adobe After Effects. + + 2. Open the submitter by choosing **File** > **Scripts** > **Run Script File**. Navigate to the `DeadlineCloudSubmitter.jsx` file and select it to run the submitter. If you recently closed the submitter, you can reopen it by choosing **File** > **Scripts** > **Recent Script Files** and selecting the `DeadlineCloudSubmitter.jsx` file. + + 3. Follow the steps in Submitting your job below. + + + + +#### System install + + 1. Launch After Effects as Admin (Windows) or with appropriate permissions (macOS). + + 2. Open the submitter by choosing **Window** > **DeadlineCloudSubmitter.jsx**. + + 3. Follow the steps in Submitting your job below. + + + + +#### Submitting your job + + 1. Choose **Open Render Queue** on the submitter. Add any composition to your render queue and set up your render settings, output module, and output path. + + 2. Choose **Refresh** on the submitter to see your composition in the composition list. + + 3. Select your composition you want to render and choose **Submit** to submit a render job. For details on available settings, see After Effects-specific settings below. + + 4. If you see a warning popup window with "You are about to run the script contained in file", you can suppress the warning by following the instruction in the popup.