Merge pull request #2193 from poanetwork/add_runtime_configured_host

feat: add BLOCKSCOUT_HOST, and use it in API docs

Author: vbaranov

CHANGELOG.md

@@ -6,6 +6,7 @@
 - [#2151](https://github.com/poanetwork/blockscout/pull/2151) - hide dropdown menu then other networks list is empty
 - [#2191](https://github.com/poanetwork/blockscout/pull/2191) - allow to configure token metadata update interval
 - [#2146](https://github.com/poanetwork/blockscout/pull/2146) - feat: add eth_getLogs rpc endpoint
+- [#2193](https://github.com/poanetwork/blockscout/pull/2193) - feat: add BLOCKSCOUT_HOST, and use it in API docs
 
 ### Fixes
 - [#2238](https://github.com/poanetwork/blockscout/pull/2238) - header content alignment issue, hide navbar on outside click

apps/block_scout_web/config/config.exs

@@ -41,7 +41,7 @@ config :block_scout_web, BlockScoutWeb.Endpoint,
     ]
   ],
   url: [
-    host: "localhost",
+    host: System.get_env("BLOCKSCOUT_HOST") || "localhost",
     path: System.get_env("NETWORK_PATH") || "/"
   ],
   render_errors: [view: BlockScoutWeb.ErrorView, accepts: ~w(html json)],

apps/block_scout_web/lib/block_scout_web/templates/api_docs/eth_rpc.html.eex

@@ -2,9 +2,9 @@
   <div class="card">
     <div class="card-body">
       <h1 class="card-title margin-bottom-sm"><%= gettext("ETH RPC API Documentation") %></h2>
-      <p class="api-text-monospace" data-endpoint-url="<%= BlockScoutWeb.Endpoint.url() %>/api/eth_rpc">[ <%= gettext "Base URL:" %> <%= @conn.host %>/api/eth_rpc ]</p>
+      <p class="api-text-monospace" data-endpoint-url="<%= BlockScoutWeb.Endpoint.url() %>/api/eth_rpc">[ <%= gettext "Base URL:" %> <%= url() %>/api/eth_rpc ]</p>
       <p class="card-subtitle margin-bottom-0">
-        <%= gettext "This API is provided to support some rpc methods in the exact format specified for ethereum nodes, which can be found " %> 
+        <%= gettext "This API is provided to support some rpc methods in the exact format specified for ethereum nodes, which can be found " %>
 
         <a href="https://github.com/ethereum/wiki/wiki/JSON-RPC"><%= gettext "here." %></a>
         <%= gettext "This is useful to allow sending requests to blockscout without having to change anything about the request." %>

apps/block_scout_web/lib/block_scout_web/templates/api_docs/index.html.eex

@@ -2,7 +2,7 @@
   <div class="card">
     <div class="card-body">
       <h1 class="card-title margin-bottom-sm"><%= gettext("API Documentation") %></h2>
-      <p class="api-text-monospace" data-endpoint-url="<%= BlockScoutWeb.Endpoint.url() %>/api">[ <%= gettext "Base URL:" %> <%= @conn.host %>/api ]</p>
+      <p class="api-text-monospace" data-endpoint-url="<%= BlockScoutWeb.Endpoint.url() %>/api">[ <%= gettext "Base URL:" %> <%= url() %>/api ]</p>
       <p class="card-subtitle margin-bottom-0"><%= gettext "This API is provided for developers transitioning their applications from Etherscan to BlockScout. It supports GET and POST requests." %></p>
     </div>
     <div class="api-anchors-list">

apps/block_scout_web/lib/block_scout_web/views/api_docs_view.ex

@@ -1,7 +1,7 @@
 defmodule BlockScoutWeb.APIDocsView do
   use BlockScoutWeb, :view
 
-  alias BlockScoutWeb.LayoutView
+  alias BlockScoutWeb.{Endpoint, LayoutView}
 
   def action_tile_id(module, action) do
     "#{module}-#{action}"
@@ -33,4 +33,12 @@ defmodule BlockScoutWeb.APIDocsView do
       "&#{param.key}=" <> "{<strong>#{param.placeholder}</strong>}"
     end)
   end
+
+  defp url do
+    if System.get_env("BLOCKSCOUT_HOST") do
+      "http://" <> System.get_env("BLOCKSCOUT_HOST")
+    else
+      Endpoint.url()
+    end
+  end
 end