From 5a5716bb71fc018d1dff0136152ab4b947c51ca2 Mon Sep 17 00:00:00 2001 From: Fredrik Lundkvist Date: Mon, 20 Jan 2025 10:23:59 +0100 Subject: [PATCH] fix: formatting on README Signed-off-by: Fredrik Lundkvist --- README.md | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index c62d0af..1199e03 100644 --- a/README.md +++ b/README.md @@ -17,28 +17,28 @@ package the output of the transcoding job referenced by the message. #### Environment variables -| Variable | Description | Default value | -| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | -| `REDIS_URL` | URL to the redis server | `redis://localhost:6379` | -| `REDIS_QUEUE` | Name of the redis queue to listen to | `packaging-queue` | -| `HOST` | Hostname or IP address to bind to for healtchechk endpoint | `0.0.0.0` | -| `PORT` | Port to bind to for healtchechk endpoint | `8000` | -| `DISABLE_HEALTCHECK` | Disable the healthcheck endpoint | `false` | -| `SHAKA_PACKAGER_EXECUTABLE` | Path to the shaka packager executable | `packager` | -| `PACKAGE_OUTPUT_FOLDER` | Base folder for output, actual output will be in a subfolder according to `OUTPUT_SUBFOLDER_TEMPLATE` | `packaged` | -| `PACKAGE_CONCURRENCY` | Number of concurrent packaging jobs | `1` | -| `PACKAGE_LISTENER_PLUGIN` | Optional path to a javascript file containing a custom listener for packaging event, see below | | -| `PACKAGE_FORMAT_OPTIONS_JSON` | Optional JSON string with format options for shaka packager, format as defined in https://github.com/Eyevinn/shaka-packager-s3/blob/main/src/packager.ts | -| `VIDEO_STREAM_KEY_TEMPLATE` | Optional template for video stream key, see below for supported keywords | `$VIDEOIDX$_$BITRATE$` | -| `AUDIO_STREAM_KEY_TEMPLATE` | Optional template for video stream key, see below for supported keywords | `$AUDIOIDX$` | -| `OUTPUT_SUBFOLDER_TEMPLATE` | Template for subfolder relative to `PACKAGE_OUTPUT_FOLDER` where output will be stored. Keywords `$INPUTNAME$`, `$JOBID$`, and `$EXTERNALID` will be replaced with basename of input, id, and external id of encore job respectively | `$INPUTNAME$/$JOBID$` | -| `DASH_MANIFEST_NAME_TEMPLATE` | Template for name of DASH manifest file. Keywords `$INPUTNAME$` and `$JOBID$` will be replaced with basename of input, and id of encore job respectively. If unset, uses default from `shaka-packager-s3` library `manifest.mpd` | | -| `HLS_MANIFEST_NAME_TEMPLATE` | Template for name of HLS manifest file. Keywords `$INPUTNAME$` and `$JOBID$` will be replaced with basename of input, and id of encore job respectively. If unset, uses default from `shaka-packager-s3` library, `index.m3u8` | | -| `ENCORE_PASSWORD` | Optional password for the encore instance `user` user | | -| `OSC_ACCESS_TOKEN` | Optional OSC access token for accessing Encore instance in OSC | | -| `AWS_ACCESS_KEY_ID` | Optional AWS access key id when `PACKAGE_OUTPUT_FOLDER` is an AWS S3 bucket | | -| `AWS_SECRET_ACCESS_KEY` | Optional AWS secret access key when `PACKAGE_OUTPUT_FOLDER` is an AWS S3 bucket | | -| `S3_ENDPOINT_URL` | Optional S3 Endpoint URL when `PACKAGE_OUTPUT_FOLDER` is an S3 bucket not on AWS | +| Variable | Description | Default value | +| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------ | +| `REDIS_URL` | URL to the redis server | `redis://localhost:6379` | +| `REDIS_QUEUE` | Name of the redis queue to listen to | `packaging-queue` | +| `HOST` | Hostname or IP address to bind to for healtchechk endpoint | `0.0.0.0` | +| `PORT` | Port to bind to for healtchechk endpoint | `8000` | +| `DISABLE_HEALTCHECK` | Disable the healthcheck endpoint | `false` | +| `SHAKA_PACKAGER_EXECUTABLE` | Path to the shaka packager executable | `packager` | +| `PACKAGE_OUTPUT_FOLDER` | Base folder for output, actual output will be in a subfolder according to `OUTPUT_SUBFOLDER_TEMPLATE` | `packaged` | +| `PACKAGE_CONCURRENCY` | Number of concurrent packaging jobs | `1` | +| `PACKAGE_LISTENER_PLUGIN` | Optional path to a javascript file containing a custom listener for packaging event, see below | | +| `PACKAGE_FORMAT_OPTIONS_JSON` | Optional JSON string with format options for shaka packager, format as defined in https://github.com/Eyevinn/shaka-packager-s3/blob/main/src/packager.ts | +| `VIDEO_STREAM_KEY_TEMPLATE` | Optional template for video stream key, see below for supported keywords | `$VIDEOIDX$_$BITRATE$` | +| `AUDIO_STREAM_KEY_TEMPLATE` | Optional template for video stream key, see below for supported keywords | `$AUDIOIDX$` | +| `OUTPUT_SUBFOLDER_TEMPLATE` | Template for subfolder relative to `PACKAGE_OUTPUT_FOLDER` where output will be stored. Keywords `$INPUTNAME$`, `$JOBID$`, and `$EXTERNALID` will be replaced with basename of input, id, and external id of encore job respectively | `$INPUTNAME$/$JOBID$` | +| `DASH_MANIFEST_NAME_TEMPLATE` | Template for name of DASH manifest file. Keywords `$INPUTNAME$` and `$JOBID$` will be replaced with basename of input, and id of encore job respectively. If unset, uses default from `shaka-packager-s3` library `manifest.mpd` | | +| `HLS_MANIFEST_NAME_TEMPLATE` | Template for name of HLS manifest file. Keywords `$INPUTNAME$` and `$JOBID$` will be replaced with basename of input, and id of encore job respectively. If unset, uses default from `shaka-packager-s3` library, `index.m3u8` | | +| `ENCORE_PASSWORD` | Optional password for the encore instance `user` user | | +| `OSC_ACCESS_TOKEN` | Optional OSC access token for accessing Encore instance in OSC | | +| `AWS_ACCESS_KEY_ID` | Optional AWS access key id when `PACKAGE_OUTPUT_FOLDER` is an AWS S3 bucket | | +| `AWS_SECRET_ACCESS_KEY` | Optional AWS secret access key when `PACKAGE_OUTPUT_FOLDER` is an AWS S3 bucket | | +| `S3_ENDPOINT_URL` | Optional S3 Endpoint URL when `PACKAGE_OUTPUT_FOLDER` is an S3 bucket not on AWS | ##### Stream key templates