diff --git a/README.md b/README.md
index 3fd63ef..226d2c9 100644
--- a/README.md
+++ b/README.md
@@ -47,6 +47,7 @@ HandBrake is a tool for converting video from nearly any format to a selection o
* [unRAID](#unraid-1)
* [Nightly Builds](#nightly-builds)
* [Debug Builds](#debug-builds)
+ * [unRAID](#unraid-2)
* [Support or Contact](#support-or-contact)
## Quick Start
@@ -655,9 +656,9 @@ Debug builds can be used to better investigate problems that can occur with
HandBrake. These builds have HandBrake
compiled in debug mode and all symbols are kept.
-The main use case of debug builds is debugging a crash. To do it, a core dump
+The main use case of debug builds is debugging a crash. To do this, a core dump
needs to be generated when HandBrake crashes. To make sure
-this appends, two things are required:
+this core dump is properly generated, two things are required:
1. Core dumps must be enabled. This is done by setting the maximum size of
cores via the `--ulimit core=-1` parameter of the `docker run` command.
@@ -668,8 +669,15 @@ this appends, two things are required:
echo 'CORE_PATTERN' | sudo tee /proc/sys/kernel/core_pattern
```
Where `CORE_PATTERN` is the template that defines the naming of core dump
- files. For example, to set the files in the config folder for easy
- retrieval, use the pattern `/config/core.%e.%t`.
+ files. For example, to set the files in the configuration volume of the
+ container (for easy retrieval from the host), use the pattern
+ `/config/core.%e.%t`.
+
+ **NOTE**: Because a core file contains the complete memory layout of an
+ application, it is created with restrictive permissions. If another user
+ other than the one used to run HandBrake needs to access
+ the core file, permissions must be changed by executing
+ `chmod a+r CORE`, where `CORE` is the path to the core file.
**NOTE**: Since the core dump files pattern is shared between the host and
the container, you may want to revert to the original pattern once
@@ -689,6 +697,11 @@ docker run [OPTIONS..] jlesage/handbrake:v1.14.3-debug
[tags on Docker Hub]: https://hub.docker.com/r/jlesage/handbrake/tags/
+### unRAID
+
+On systems running unRAID, the `--ulimit core=-1` parameter can be added to the
+`Extra Parameters` field of the container settings.
+
[TimeZone]: http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
## Support or Contact
diff --git a/appdefs.xml b/appdefs.xml
index bc4d45b..a564350 100644
--- a/appdefs.xml
+++ b/appdefs.xml
@@ -260,9 +260,9 @@ Debug builds can be used to better investigate problems that can occur with
{{ defs.app.friendly_name }}. These builds have {{ defs.app.friendly_name }}
compiled in debug mode and all symbols are kept.
-The main use case of debug builds is debugging a crash. To do it, a core dump
+The main use case of debug builds is debugging a crash. To do this, a core dump
needs to be generated when {{ defs.app.friendly_name }} crashes. To make sure
-this appends, two things are required:
+this core dump is properly generated, two things are required:
1. Core dumps must be enabled. This is done by setting the maximum size of
cores via the `--ulimit core=-1` parameter of the `docker run` command.
@@ -273,8 +273,15 @@ this appends, two things are required:
echo 'CORE_PATTERN' | sudo tee /proc/sys/kernel/core_pattern
```
Where `CORE_PATTERN` is the template that defines the naming of core dump
- files. For example, to set the files in the config folder for easy
- retrieval, use the pattern `/config/core.%e.%t`.
+ files. For example, to set the files in the configuration volume of the
+ container (for easy retrieval from the host), use the pattern
+ `/config/core.%e.%t`.
+
+ **NOTE**: Because a core file contains the complete memory layout of an
+ application, it is created with restrictive permissions. If another user
+ other than the one used to run {{ defs.app.friendly_name }} needs to access
+ the core file, permissions must be changed by executing
+ `chmod a+r CORE`, where `CORE` is the path to the core file.
**NOTE**: Since the core dump files pattern is shared between the host and
the container, you may want to revert to the original pattern once
@@ -295,6 +302,13 @@ docker run [OPTIONS..] jlesage/{{ defs.app.name }}:v1.14.3-debug
[tags on Docker Hub]: https://hub.docker.com/r/jlesage/{{ defs.app.name }}/tags/
+
+ unRAID
+
+On systems running unRAID, the `--ulimit core=-1` parameter can be added to the
+`Extra Parameters` field of the container settings.
+
+