Add Ability to Override the Base URL of Generated Links (#330)

* Add Ability to Override the Base URL of Generated Links

* Update config documentation

* Fix wording

Author: pglombardo

Configuration.md

@@ -93,14 +93,6 @@ export PWP__MAIL__MAILER_SENDER='"Spiderman" <thespider@mycompany.org>'
 * See also this [Github discussion](https://github.com/pglombardo/PasswordPusher/issues/265#issuecomment-964432942).
 * [External Documentation on mailer configuration](https://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration) for the underlying technology if you need more details for configuration issues.
 
-# Forcing SSL Links
-
-See also the Proxies section below.
-
-| Environment Variable | Description |
-| --------- | ------------------ |
-| FORCE_SSL | The existence of this variable will set `config.force_ssl` to `true` and generate HTTPS based secret URLs
-
 # Google Analytics
 
 | Environment Variable | Description |
@@ -109,10 +101,24 @@ See also the Proxies section below.
 | GA_ACCOUNT | The Google Analytics account id.  E.g. `UA-XXXXXXXX-X` |
 | GA_DOMAIN | The domain where the application is hosted.  E.g. `pwpush.com` |
 
+# Forcing SSL Links
+
+See also the Proxies section below.
+
+| Environment Variable | Description |
+| --------- | ------------------ |
+| FORCE_SSL | The existence of this variable will set `config.force_ssl` to `true` and generate HTTPS based secret URLs
+
 # Proxies
 
 An occasional issue is that when using Password Pusher behind a proxy, the generated secret URLs are incorrect.  They often have the backend URL & port instead of the public fully qualified URL - or use HTTP instead of HTTPS (or all of the preceding).
 
 To resolve this, make sure your proxy properly forwards the `X-Forwarded-Host`, `X-Forwarded-Port` and `X-Forwarded-Proto` headers.
 
 The values in these headers represent the front end request.  When these headers are sent, Password Pusher can then build the correct URLs.
+
+If you are unable to have these headers passed to the application for any reason, you could instead force an override of the base URL using the `PWP__OVERRIDE_BASE_URL` environment variable.
+
+| Environment Variable | Description | Example Value |
+| --------- | ------------------ | --- |
+| PWP__OVERRIDE_BASE_URL | Set this value (without a trailing slash) to force the base URL of generated links. | 'https://subdomain.domain.dev'

app/helpers/passwords_helper.rb

@@ -1,12 +1,20 @@
 module PasswordsHelper
   def raw_secret_url(password)
     push_locale = params['push_locale'] || I18n.locale
-    raw_url = I18n.with_locale(push_locale) do
-      password_url(password)
+
+    if Settings.override_base_url
+      raw_url = I18n.with_locale(push_locale) do
+        Settings.override_base_url + password_path(password)
+      end
+    else
+      raw_url = I18n.with_locale(push_locale) do
+        password_url(password)
+      end
+
+      # Support forced https links with FORCE_SSL env var
+      raw_url.gsub(/http/i, 'https') if ENV.key?('FORCE_SSL') && !request.ssl?
     end
 
-    # Support forced https links with FORCE_SSL env var
-    raw_url.gsub(/http/i, 'https') if ENV.key?('FORCE_SSL') && !request.ssl?
     raw_url
   end
 

config/settings.yml

@@ -18,6 +18,18 @@ enable_logins: false
 # Used in generating fully qualified URLs.
 host_protocol: 'https'
 
+# Set the following value to force the base URL of generated links.
+#
+# Environment variable override:
+# PWP__OVERRIDE_BASE_URL='https://pwpush.mydomain.com'
+#
+# You could even add a port if needed:
+# PWP__OVERRIDE_BASE_URL='https://pwpush.mydomain.com:5100'
+#
+# Set this value without a trailing slash ('/').
+#
+# override_base_url: 'https://pwpush.mydomain.com'
+
 # When logins are enabled, an SMTP server is required to send emails to users
 # for things such as forgot password, unlock account, confirm account etc.
 # If `enable_logins` is set to true above, the following _are required_ to be