Github user lukaszlenart commented on a diff in the pull request:
https://github.com/apache/struts-extras/pull/3#discussion_r108591475
--- Diff: struts2-custom-results-plugin/README.md ---
@@ -0,0 +1,42 @@
+# Apache Struts 2 Extras - custom results plugin
+
+[](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+This plugin provides additional result types.
+
+## Supported versions
+
+This plugin can be used with the Apache Struts versions 2.5.x .
+
+## Result Type categories
+
+### SSL offloading support
+
+These result types are made to support redirecting under the https
protocol while being behind a SSL offloading proxy.
+
+#### Result Types
+
+##### sslOffloadRedirect
+
+This Result Type should replace the `redirect` Result Type.
+It takes into account 2 ways of detecting the offloading:
+- `X-Forwarded-Proto` header (de-facto standard header)
+- `proto` attribute of the `Forwarded` header (
[RFC7239](https://tools.ietf.org/html/rfc7239) )
+
+##### sslOffloadRedirectAction
+
+This Result Type should replace the `redirectAction` Result Type.
+It takes into account 2 ways of detecting the offloading:
+- `X-Forwarded-Proto` header (de-facto standard header)
+- `proto` attribute of the `Forwarded` header (
[RFC7239](https://tools.ietf.org/html/rfc7239) )
+
+#### struts packages
+
+##### ssl-offload
+
+Only thing this package does is defining the result types so that they can
be used.
+
+##### ssl-offload-default
+
+Merely combines the `struts-default` package and the `ssl-offload` package.
--- End diff --
The most of the users don't know that they can extend multiple packages,
and some always prepare a dedicated package without extending any. It's just a
suggestion how they can use those results without melting too much in packages
:)
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@struts.apache.org
For additional commands, e-mail: dev-h...@struts.apache.org
