Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Craighton Hancock committed Apr 24, 2023
1 parent 9d51549 commit 32a6149
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The following key/value pairs should be located in one or more `yaml` files moun
| `ffmpeg.run` | switch to control whether call to ffmpeg is allowed; useful to set `false` for debugging | `true` |
| `ffmpeg.path` | path to ffmpeg; if ffmpeg is in `PATH`, keep default value | `ffmpeg` |
| `ffmpeg.additional_args` | list of extra args added to ffmpeg call; see [ffmpeg Additional Args](#ffmpeg-additional-args) for more details | `['-hide_banner', '-loglevel', 'error', '-nostats', '-y']` |
| `logging.level` | controls logging verbosity; can be one of `info`, `warning`, `error`, `debug` | `info` |
| `logging.level` | controls logging verbosity; can be one of `info`, `warning`, `error`, `debug`; see [Debug Logging](#debug-logging) for important information on security concerns | `info` |
| `logging.format` | controls desired logging format | `'%(asctime)s - %(levelname)s - [%(name)s] %(message)s'` |

## Python Secrets
Expand Down Expand Up @@ -83,4 +83,7 @@ If your `input.path` is an `nfs` shared folder, you must use the `python` releas
The additional args will be added to the command between `ffmpeg` and `-activation_bytes`. Some options will not work where these are placed. Following is an example command with default values:
```
ffmpeg -hide_banner -loglevel error -nostats -y -activation_bytes <activation_bytes> -i <input.path> -c copy <output.path>
```
```

### Debug Logging
If debug logging is enabled, your `activation_bytes` will be written to stdout. Depending on your environment, this may mean your `activation_bytes` will be logged in plain text to a file on disk.

0 comments on commit 32a6149

Please sign in to comment.