Ci: updated how blockscan is built and deployed

.github/workflows/docker-build.yml

@@ -0,0 +1,39 @@
+name: Build Docker And Push
+on:
+  push:
+    tags:
+    branches:
+      - main
+      - dev
+  workflow_dispatch:
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: blockscan
+
+jobs:
+  Build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write    
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+
+      - name: Build and Push Docker Image
+        uses: docker/build-push-action@v2
+        with:
+          context: ./
+          file: ./docker/Dockerfile
+          push: true
+          tags: ghcr.io/magickbase/${{env.IMAGE_NAME}}:latest

README.md

@@ -6,11 +6,10 @@ BlockScan is a explorer for ETH compatible chain like [Axon](https://github.com/
 ## Getting Started
   1. install latest docker and docker compose
   2. run pg database on the host machine
-  3. edit `xxx.env` file
-  4. build command `docker-compose --env-file ./dev.env -f ./docker-compose.yml build blockscan`
-  5. run database `docker-compose --env-file ./dev.env  -f ./docker-compose.yml up --force-recreate db`
-  6. run command `docker-compose --env-file ./dev.env  -f ./docker-compose.yml up --force-recreate blockscan`
-  7. use your env file instead of dev.env
+  3. edit `xxx.env` file change `ETHEREUM_JSONRPC_HTTP_URL` `ETHEREUM_JSONRPC_HTTP_URL`  to the rpc domain name or ip+ port of the chain now in use
+  4. run database `docker-compose   -f ./docker-compose.yml up --force-recreate db`
+  5. run command `docker-compose   -f ./docker-compose.yml up --force-recreate blockscan`
+  6. use your env file instead of dev.env
 ## Github Action
   1. setting your forked project environment: "axon_staging" (you can change it in your github workflow file)
   2. setting secret environment `ENV_FILE_PATH` which directing real path of your .env file on the deployment server

dev.env

@@ -1,56 +1,30 @@
-# DOCKER_TAG=
 ETHEREUM_JSONRPC_VARIANT=geth
 
 
-ETHEREUM_JSONRPC_HTTP_URL=https://axon1.layerview.io/
-ETHEREUM_JSONRPC_TRACE_URL=https://axon1.layerview.io/
+ETHEREUM_JSONRPC_HTTP_URL=http://localhost:8000
+ETHEREUM_JSONRPC_TRACE_URL=http://localhost:8000
 DATABASE_URL=postgresql://postgres:postgres123@db:5432/blockscan?ssl=false
-# DATABASE_URL=postgresql://postgres:postgres@127.0.0.1:5432/blockscan?ssl=false
 
 NETWORK=Axon
 SUBNETWORK=AxonChain
 LOGO=/images/blockscout_logo.svg
 LOGO_FOOTER=/images/blockscout_logo.svg
-# ETHEREUM_JSONRPC_WS_URL=
 ETHEREUM_JSONRPC_TRANSPORT=http
 IPC_PATH=
 NETWORK_PATH=/
 API_PATH=/
 SOCKET_ROOT=/
 BLOCKSCOUT_HOST=
 BLOCKSCOUT_PROTOCOL=
-# SECRET_KEY_BASE=
-# CHECK_ORIGIN=
 PORT=4020
-# COIN=
-# COIN_NAME=
-# COINGECKO_COIN_ID=
-# METADATA_CONTRACT=
-# VALIDATORS_CONTRACT=
-# KEYS_MANAGER_CONTRACT=
-# REWARDS_CONTRACT=
-# TOKEN_BRIDGE_CONTRACT=
 EMISSION_FORMAT=DEFAULT
-# CHAIN_SPEC_PATH=
-# SUPPLY_MODULE=
-# SOURCE_MODULE=
 POOL_SIZE=40
 POOL_SIZE_API=10
 ECTO_USE_SSL=false
-# DATADOG_HOST=
-# DATADOG_PORT=
-# SPANDEX_BATCH_SIZE=
-# SPANDEX_SYNC_THRESHOLD=
 HEART_BEAT_TIMEOUT=30
-# HEART_COMMAND=
 BLOCKSCOUT_VERSION=
 RELEASE_LINK=
 BLOCK_TRANSFORMER=axon
-# GRAPHIQL_TRANSACTION=
-# FIRST_BLOCK=
-# LAST_BLOCK=
-# TRACE_FIRST_BLOCK=
-# TRACE_LAST_BLOCK=
 LINK_TO_OTHER_EXPLORERS=false
 OTHER_EXPLORERS={}
 SUPPORTED_CHAINS={}
@@ -79,8 +53,6 @@ DISABLE_WRITE_API=false
 DISABLE_INDEXER=false
 INDEXER_DISABLE_PENDING_TRANSACTIONS_FETCHER=true
 INDEXER_DISABLE_INTERNAL_TRANSACTIONS_FETCHER=true
-# WEBAPP_URL=
-# API_URL=
 WOBSERVER_ENABLED=false
 SHOW_ADDRESS_MARKETCAP_PERCENTAGE=true
 CHECKSUM_ADDRESS_HASHES=true
@@ -96,15 +68,7 @@ TXS_STATS_DAYS_TO_COMPILE_AT_INIT=10
 COIN_BALANCE_HISTORY_DAYS=90
 APPS_MENU=true
 EXTERNAL_APPS=[]
-# ETH_OMNI_BRIDGE_MEDIATOR=
-# BSC_OMNI_BRIDGE_MEDIATOR=
-# AMB_BRIDGE_MEDIATORS=
-# GAS_PRICE=
-# FOREIGN_JSON_RPC=
-# RESTRICTED_LIST=
-# RESTRICTED_LIST_KEY=
 DISABLE_BRIDGE_MARKET_CAP_UPDATER=true
-# POS_STAKING_CONTRACT=
 INDEXER_DISABLE_BLOCK_REWARD_FETCHER=true
 ENABLE_POS_STAKING_IN_MENU=false
 SHOW_MAINTENANCE_ALERT=false
@@ -115,7 +79,6 @@ CUSTOM_CONTRACT_ADDRESSES_TEST_TOKEN=
 ENABLE_SOURCIFY_INTEGRATION=false
 SOURCIFY_SERVER_URL=
 SOURCIFY_REPO_URL=
-# CHAIN_ID=
 MAX_SIZE_UNLESS_HIDE_ARRAY=50
 HIDE_BLOCK_MINER=false
 DISPLAY_TOKEN_ICONS=false
@@ -124,7 +87,6 @@ TENDERLY_CHAIN_PATH=
 MAX_STRING_LENGTH_WITHOUT_TRIMMING=2040
 RE_CAPTCHA_SECRET_KEY=
 RE_CAPTCHA_CLIENT_KEY=
-# JSON_RPC=
 API_RATE_LIMIT=50
 API_RATE_LIMIT_BY_KEY=50
 API_RATE_LIMIT_BY_IP=50

docker-compose.yml

@@ -16,168 +16,28 @@ services:
       # POSTGRES_HOST_AUTH_METHOD: 'trust'
     ports:
       - 27543:5432
+    env_file:
+      -  ./dev.env
     volumes:
-      - db:/var/lib/postgresql/data
+      - "db:/var/lib/postgresql/data"
     extra_hosts:
       - 'host.docker.internal:host-gateway'
 
   blockscan:
-    image: blockscan/blockscan:${DOCKER_TAG:-latest}
-    # depends_on:
-    #   - db
+    image: ghcr.io/magickbase/blockscan:${DOCKER_TAG:-latest}
+    depends_on:
+      - db
     links:
       - db:database
-    build:
-      context: ./
-      dockerfile: ./docker/Dockerfile
-      args:
-        COIN: ""
-        CACHE_EXCHANGE_RATES_PERIOD: ""
-        API_V1_READ_METHODS_DISABLED: "false"
-        DISABLE_WEBAPP: "false"
-        API_V1_WRITE_METHODS_DISABLED: "false"
-        CACHE_TOTAL_GAS_USAGE_COUNTER_ENABLED: ""
-        CACHE_ADDRESS_WITH_BALANCES_UPDATE_INTERVAL: ""
-        ADMIN_PANEL_ENABLED: ""
-        RELEASE_VERSION: 5.1.4
     restart: always
     container_name: 'blockscan'
     # command: 'elixir --name blockscan@127.0.0.1 -S mix do ecto.create, ecto.migrate, phx.server'
     command: bash -c "bin/blockscout eval \"Elixir.Explorer.ReleaseTasks.create_and_migrate()\" && bin/blockscout start"
     extra_hosts:
       - 'host.docker.internal:host-gateway'
-    # env_file:
-    #   -  ./docker-compose/envs/common-blockscout.env
-
-    environment:
-      - MIX_ENV=prod
-      - DOCKER_TAG
-      - ETHEREUM_JSONRPC_VARIANT
-      - ETHEREUM_JSONRPC_HTTP_URL
-      - DATABASE_URL
-      - ETHEREUM_JSONRPC_TRACE_URL
-      - NETWORK
-      - SUBNETWORK
-      - LOGO
-      - LOGO_FOOTER
-      - ETHEREUM_JSONRPC_WS_URL
-      - ETHEREUM_JSONRPC_TRANSPORT
-      - IPC_PATH
-      - NETWORK_PATH
-      - API_PATH
-      - SOCKET_ROOT
-      - BLOCKSCOUT_HOST
-      - BLOCKSCOUT_PROTOCOL
-      - SECRET_KEY_BASE
-      - CHECK_ORIGIN
-      - PORT
-      - COIN
-      - COIN_NAME
-      - COINGECKO_COIN_ID
-      - METADATA_CONTRACT
-      - VALIDATORS_CONTRACT
-      - KEYS_MANAGER_CONTRACT
-      - REWARDS_CONTRACT
-      - TOKEN_BRIDGE_CONTRACT
-      - EMISSION_FORMAT
-      - CHAIN_SPEC_PATH
-      - SUPPLY_MODULE
-      - SOURCE_MODULE
-      - POOL_SIZE
-      - POOL_SIZE_API
-      - ECTO_USE_SSL
-      - DATADOG_HOST
-      - DATADOG_PORT
-      - SPANDEX_BATCH_SIZE
-      - SPANDEX_SYNC_THRESHOLD
-      - HEART_BEAT_TIMEOUT
-      - HEART_COMMAND
-      - BLOCKSCOUT_VERSION
-      - RELEASE_LINK
-      - BLOCK_TRANSFORMER
-      - GRAPHIQL_TRANSACTION
-      - FIRST_BLOCK
-      - LAST_BLOCK
-      - TRACE_FIRST_BLOCK
-      - TRACE_LAST_BLOCK
-      - LINK_TO_OTHER_EXPLORERS
-      - OTHER_EXPLORERS
-      - SUPPORTED_CHAINS
-      - CACHE_BLOCK_COUNT_PERIOD
-      - CACHE_TXS_COUNT_PERIOD
-      - CACHE_ADDRESS_COUNT_PERIOD
-      - CACHE_ADDRESS_SUM_PERIOD
-      - CACHE_TOTAL_GAS_USAGE_PERIOD
-      - CACHE_ADDRESS_TRANSACTIONS_GAS_USAGE_COUNTER_PERIOD
-      - CACHE_TOKEN_HOLDERS_COUNTER_PERIOD
-      - CACHE_TOKEN_TRANSFERS_COUNTER_PERIOD
-      - CACHE_ADDRESS_WITH_BALANCES_UPDATE_INTERVAL
-      - CACHE_AVERAGE_BLOCK_PERIOD
-      - CACHE_MARKET_HISTORY_PERIOD
-      - CACHE_ADDRESS_TRANSACTIONS_PERIOD
-      - CACHE_ADDRESS_TOKENS_USD_SUM_PERIOD
-      - CACHE_ADDRESS_TOKEN_TRANSFERS_COUNTER_PERIOD
-      - CACHE_BRIDGE_MARKET_CAP_UPDATE_INTERVAL
-      - CACHE_TOKEN_EXCHANGE_RATE_PERIOD
-      - TOKEN_METADATA_UPDATE_INTERVAL
-      - ALLOWED_EVM_VERSIONS
-      - UNCLES_IN_AVERAGE_BLOCK_TIME
-      - DISABLE_WEBAPP
-      - DISABLE_READ_API
-      - DISABLE_WRITE_API
-      - DISABLE_INDEXER
-      - INDEXER_DISABLE_PENDING_TRANSACTIONS_FETCHER
-      - INDEXER_DISABLE_INTERNAL_TRANSACTIONS_FETCHER
-      - WEBAPP_URL
-      - API_URL
-      - WOBSERVER_ENABLED
-      - SHOW_ADDRESS_MARKETCAP_PERCENTAGE
-      - CHECKSUM_ADDRESS_HASHES
-      - CHECKSUM_FUNCTION
-      - DISABLE_EXCHANGE_RATES
-      - DISABLE_KNOWN_TOKENS
-      - ENABLE_TXS_STATS
-      - SHOW_PRICE_CHART
-      - SHOW_TXS_CHART
-      - HISTORY_FETCH_INTERVAL
-      - TXS_HISTORIAN_INIT_LAG
-      - TXS_STATS_DAYS_TO_COMPILE_AT_INIT
-      - COIN_BALANCE_HISTORY_DAYS
-      - APPS_MENU
-      - EXTERNAL_APPS
-      - ETH_OMNI_BRIDGE_MEDIATOR
-      - BSC_OMNI_BRIDGE_MEDIATOR
-      - AMB_BRIDGE_MEDIATORS
-      - GAS_PRICE
-      - FOREIGN_JSON_RPC
-      - RESTRICTED_LIST
-      - RESTRICTED_LIST_KEY
-      - DISABLE_BRIDGE_MARKET_CAP_UPDATER
-      - POS_STAKING_CONTRACT
-      - INDEXER_DISABLE_BLOCK_REWARD_FETCHER
-      - ENABLE_POS_STAKING_IN_MENU
-      - SHOW_MAINTENANCE_ALERT
-      - MAINTENANCE_ALERT_MESSAGE
-      - SHOW_STAKING_WARNING
-      - STAKING_WARNING_MESSAGE
-      - CUSTOM_CONTRACT_ADDRESSES_TEST_TOKEN
-      - ENABLE_SOURCIFY_INTEGRATION
-      - SOURCIFY_SERVER_URL
-      - SOURCIFY_REPO_URL
-      - CHAIN_ID
-      - MAX_SIZE_UNLESS_HIDE_ARRAY
-      - HIDE_BLOCK_MINER
-      - DISPLAY_TOKEN_ICONS
-      - SHOW_TENDERLY_LINK
-      - TENDERLY_CHAIN_PATH
-      - MAX_STRING_LENGTH_WITHOUT_TRIMMING
-      - RE_CAPTCHA_SECRET_KEY
-      - RE_CAPTCHA_CLIENT_KEY
-      - JSON_RPC
-      - API_RATE_LIMIT
-      - API_RATE_LIMIT_BY_KEY
-      - API_RATE_LIMIT_BY_IP
-      - API_RATE_LIMIT_WHITELISTED_IPS
-      - API_RATE_LIMIT_STATIC_API_KEY
+    env_file:
+      -  ./dev.env
     ports:
       - 4020:4020
+
+