Skip to content

Commit

Permalink
fix: formatting on README
Browse files Browse the repository at this point in the history 
Signed-off-by: Fredrik Lundkvist <[email protected]>
  • Loading branch information
@Lunkers
Lunkers committed Jan 20, 2025
1 parent 54cc47b commit 5a5716b
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 5a5716b

Please sign in to comment.