File Browser
  • Welcome
  • Features
  • Installation
  • Upgrade from 1.x
  • Command Line Interface
    • filebrowser
    • filebrowser cmds
    • filebrowser cmds add
    • filebrowser cmds ls
    • filebrowser cmds rm
    • filebrowser config
    • filebrowser config cat
    • filebrowser config export
    • filebrowser config import
    • filebrowser config init
    • filebrowser config set
    • filebrowser hash
    • filebrowser rules
    • filebrowser rules add
    • filebrowser rules ls
    • filebrowser rules rm
    • filebrowser upgrade
    • filebrowser users
    • filebrowser users add
    • filebrowser users export
    • filebrowser users find
    • filebrowser users import
    • filebrowser users ls
    • filebrowser users rm
    • filebrowser users update
    • filebrowser version
  • Configuration
    • Custom Branding
    • Authentication Method
    • Command Runner
  • Contributing
    • Authentication Provider
    • Translations
    • CI and Releases
    • Code of Conduct
Powered by GitBook
On this page

Was this helpful?

  1. Configuration

Custom Branding

PreviousConfigurationNextAuthentication Method

Last updated 1 year ago

Was this helpful?

You are able to customize your File Browser installation by changing its name to any other you want, by adding a global custom style sheet and by using your own logotype if you want. To address this, there are three configuration options that can be changed:

  • Name: which is the instance name that will show up on login and signup pages. This won't replace the version message in the sidebar.

  • Disable external links: this will disable any external links (except the ones to this documentation).

  • Folder: is the path to a directory that can contain two items:

    • custom.css, containing the styles you want to apply to your installation.

    • img a directory whose files can replace the in the application.

These options can be either set via the CLI interface using the following command:

filebrowser config set --branding.name "My Name" \
    --branding.files "/abs/path/to/my/dir" \
    --branding.disableExternal

Or can be set under 'Branding directory path' in Settings → Global Settings.

If using Docker then remember to bind this directory, for example as `/home/username/containers/filebrowser/branding:/branding`

For custom icons to be recognised you need to create img and img/icons directories and place the svg in the branding/img directory:

To replace the favicon you need to place this in the img/icons directory but also note that some of the other PNG icon types will be required too (see the default logotypes link above) as the browser will normally use the highest resolution option available (at a minimum the 16x16 and 32x32 options). You can use the to generate these for you from your base image.

The icons are cached, to make the new ones appear more quickly open developer tools in your browser, then click on the Application tab, then Storage and then 'Clear Site Data'.

default logotypes
Real Favicon Generator
filebrowser customisation tree