Expand Docker documentation #49
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Expand Docker documentation
This PR mostly expands on Docker-related documentation for Redlib. Configuration using an
.envfile for Docker deployments is now covered.Some formatting changes have also been made in the README (headings and admonitions).
An error in
compose.yamlthat causes Docker Compose deployments to break has also been fixed (see last bullet point).Change summary
As a quick summary of changes:
README.mdas well as values incompose.yamlto explicitly specify thelatesttag for the Redlib image.README.mdAdded a new section covering Docker Compose deployments.
Added documentation covering the use of a
.envfile to configure Redlib using environment variables for Docker deployments.Added a short section on networking considerations for Docker deployments behind a reverse proxy.
Fixed formatting for admonitions in the README. A line break now appears between the title and the rest of the admonition text.
Separated configuration into a subsection under Deployment to better accommodate the new section for configuration when using Docker.
compose.yamlPrefixed the
arm64andarmv7images incompose.yamlwithimage:so that it's in line withlatestimage.Changed the name of the Redlib service from
webtoredlib.Changed
seccomp="seccomp-redlib.json"toseccomp=seccomp-redlib.jsonto fix an error about the seccomp profile not being found when deploying using Docker Compose.