SupportWebsiteGithubDiscord

Branding Configs

See the ENV Variables page for more info on specific variables mentioned below.

Note: if you've previously deployed and are updating your BlockScout version with new assets, be sure to remove static assets from the previous build (use mix phx.digest.cleanor manually delete assets located in apps/block_scout_web/priv/static folder) before updating current files and restarting/rebuilding BlockScout.

In order to rebuild new front-end assets run the following. Note: If preferred, use npm ci rather than npm install to strictly follow all package versions in package-lock.json

  1. cd apps/block_scout_web/assets; npm install && node_modules/webpack/bin/webpack.js --mode production; cd -

  2. mix phx.digest

  1. Theme Colors and other CSS-based attributes: See CSS Configs and Presets to set your instance to the stylesheet you want to use.

  2. Logos: Use the LOGO and FOOTER_LOGO env variables to direct to your uploaded logos. Logos and other assets are located in the apps/block_scout_web/assets/static/images folder.

  3. Coin: Customize the coin symbol using the COIN & COINGECKO_COIN_ID env variables.

  4. MetaData: MetaTags can be adjusted for various pages in the templates area. For the home page, tag data is rendered from here: /apps/block_scout_web/lib/block_scout_web/templates/chain/_metatags.html.eex

  5. Titles / Subtitles: Browser tab displays the title from the 2 SUBNETWORK + NETWORK env variables.

  6. Favicon: replace the current favicons located in the apps/block_scout_web/assets/static/images folder.

  7. Menus: Use the APPS_MENU env variable to include an apps menu and EXTERNAL_APPS to populate the menu.

  8. Top navigation bar: Data is rendered from here:

    /apps/block_scout_web/lib/block_scout_web/templates/layout/_topnav.html.eex

  9. Footer: Data is rendered from here: /apps/block_scout_web/lib/block_scout_web/templates/layout/_footer.html.eex ENV variables for footer links

    1. FOOTER_CHAT_LINK ​

    2. FOOTER_FORUM_LINK

    3. FOOTER_GITHUB_LINK

  10. Custom Theming: Custom theming is available from the BlockScout team. Contact us in Discord for more information.

Last updated

Was this helpful?