Spring Boot custom favicon.ico not showing

Question

I know this question has been asked over and over here and there are several solutions. I've tried several of those except the ones that suggests writing you own configuration bean for this. I don't want to do all that just to display a tiny icon it seams overkill. But I can not get it to work. These are the solutions I've tried so far.

just add favicon.ico under static resources and it should work....it doesn't.
spring.mvc.favicon.enabled=false in application.properties, no favicon showed at all (which I guess is the whole point of that).
Tried 2 examples of including the favicon as a link in the html pages. Like so: <link rel="icon" type="image/png" href="favicon.png" /> <link rel="icon" type="image/x-icon" href="favicon.ico" />

Neither of those work.

Tried renaming my own favicon to something else and reference it as above. Does not work.

When inspecting the page in the browser I sometimes get no error at all printed out despite no icon showing, or I get an error saying GET http://localhost:8080/myapp/favicon.png 404 () Where it is refering the type as JSON (which I find strange).

I'm running out of ideas here so if anyone can tell me why this is not working please let me know. Did I perhaps forget one of those magic spring annotations? This is what my main class looks like.

@SpringBootApplication 
@ComponentScan
@Configuration
@EnableWebMvc
public class JobengineMonitorApplication implements CommandLineRunner {

    public static void main(String[] args) {
        SpringApplication.run(JobengineMonitorApplication.class, args);
    }

 }

I am using thymeleaf as the template engine

score 16 · Answer 1 · answered Apr 05 '18 at 18:12

16

I solved this problem by putting favicon.ico in main/resource/static and adding this lines to my security config

 httpSecurity
            .authorizeRequests()
                .antMatchers( "/favicon.ico").permitAll()

answered Apr 05 '18 at 18:12

JaneXQ

380
1
3
9

score 10 · Answer 2 · answered Sep 19 '17 at 13:47

10

I have this with SpringBoot configuration too and is working

<link rel="shortcut icon" type="image/png" th:href="@{/img/favicon.png}"/>

And the favicon.png under resources/public/img

answered Sep 19 '17 at 13:47

cralfaro

5,822
3
20
30

1

For me it was `th:href="@{/favicon.ico}"` to resolve `/src/main/resources/static/favicon.ico`. – membersound Aug 11 '22 at 14:37

Nikita Shcherbakov · Answer 3 · 2021-05-06T21:12:26.017

If anyone faces the same problem using newer version of Spring (in my case spring boot 2.4.4), here's the scenario that worked fine for me:

Put the favicon.ico in the /resources/static folder. I also tried to put it just in the /resourses/ folder and it worked fine as well, so do not worry about the folder that much.
Create a FaviconConfiguration in your configurations folder with the following content:

@Configuration
public class FaviconConfiguration {

    @Bean
    public SimpleUrlHandlerMapping customFaviconHandlerMapping() {
        SimpleUrlHandlerMapping mapping = new SimpleUrlHandlerMapping();
        mapping.setOrder(Integer.MIN_VALUE);
        mapping.setUrlMap(Collections.singletonMap(
                "/static/favicon.ico", faviconRequestHandler()));
        return mapping;
    }

    @Bean
    protected ResourceHttpRequestHandler faviconRequestHandler() {
        ResourceHttpRequestHandler requestHandler
                = new ResourceHttpRequestHandler();
        requestHandler.setLocations(Collections.singletonList(new ClassPathResource("/")));
        return requestHandler;
    }
}

In case you use Spring Security don't forget to add antMatcher for your favicon resource by adding the following code to your SpringSecurityConfiguration (as JaneXQ already mentioned above):

.antMatchers("/static/favicon.ico").permitAll()

Use link to your custom favicon explicitly in your html. To do that just put the following link in the <head> section of each of your html pages in the following way (I used thymeleaf in here):

<head>
    ...
    <link rel="icon" type="image/ico" th:href="@{../static/favicon.ico}">
    ...
</head>

I hate that this is the only thing I got to work. It is way overblown for the favicon, but this works! — mmaceachran, Jun 14 '21 at 04:02
Yeah, sir. I kinda had done a little research spending hours before I got it worked fine for me — Nikita Shcherbakov, Jul 17 '21 at 17:07

score 3 · Answer 4 · answered Jun 24 '19 at 07:39

3

I found I had to put my favicon.ico file in:

src/main/resources/public

answered Jun 24 '19 at 07:39

Bohemian

412,405
93
575
722

can you share the config? I also have it in public but still default is loaded – Alex Bondar Sep 09 '19 at 18:42
@alex I used no special config for this – Bohemian Sep 09 '19 at 21:56

score 3 · Answer 5 · answered Oct 17 '20 at 15:54

3

Put your favicon.png under src/main/resources/public and add this to your *.html page exactly in the header section

 <link rel="shortcut icon" type="image/png" th:href="@{favicon.png}"/>

answered Oct 17 '20 at 15:54

Ikbel

1,817
1
17
30

score 2 · Answer 6 · answered Aug 19 '21 at 14:03

2

I saved my favicon which was a simple .png download as src/main/resources/static/favicon.ico

I couldn't get it to display until I tried another browser and it worked fine - so try clearing the browser cache, or try testing on another browser

answered Aug 19 '21 at 14:03

oldbird

21
1

Great reminder - clear the browser cache after trying some of these solutions! I tried multiple solutions (who knows how many would have worked) but only after clearing the browser cache did my favicon appear. For me, I did not have to configure a custom favicon bean, so try the simpler fixes, clear the cache, and see if that works! – TheKearnol Feb 05 '22 at 19:11

score 1 · Accepted Answer · answered Sep 19 '17 at 14:02

1

Ok so this appears to be working now. Of course I managed to get it working just after ranting about it :).

Anyway, what i did was.

Remove @EnableWebMvc from the main class
For added ../ to the href depending on the urls e.g /index was fine but /edit/something.html was not

Sorry for wasting peoples time but hopefully this could be useful for another rookie like me

answered Sep 19 '17 at 14:02

Johan Fredin

573
2
5
12

did you try the solution i proposed? Is something is working in my project and seems quite easy and no configuration – cralfaro Sep 20 '17 at 08:50
Why did you remove EnableWebMVC ? Did you get your attempt (1) to work? setting "favico.ico" in static resources. I am having issues with that. – JayC Jan 28 '20 at 16:21

score 1 · Answer 8 · answered May 08 '21 at 13:50

1

Try to replace th:href with href. It worked for me.

<link rel="icon" href="/favicon.ico" type="image/ico">

answered May 08 '21 at 13:50

roy ren

11
1

Does this address the question? The OP does not mention using `th:href`. – ZX9 May 08 '21 at 18:32
That simply did the trick (and automatically resolved from `/src/main/resources/static/favicon.ico` – membersound Aug 11 '22 at 14:36

score 0 · Answer 9 · answered Jan 17 '21 at 13:18

0

For some reason .ico format was not working. I just placed a png image instead and spring automatically picked the favicon.

I placed the png image in \src\main\resources\public

Spring boot + thymeleaf

answered Jan 17 '21 at 13:18

Arv

427
4
6

score 0 · Answer 10 · answered Sep 14 '21 at 17:55

0

I had the same issue and fix it removing @EnableAdminServer annotation

answered Sep 14 '21 at 17:55

horelvis

125
5

score 0 · Answer 11 · answered May 23 '23 at 08:15

Spring boot

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.0.6'
    id 'io.spring.dependency-management' version '1.1.0'
}

group = 'com.security.web'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'

to generate Favicon.ico
to edit *.html

 <link rel="shortcut icon" type="image/x-icon" th:href="@{favicon.ico}"/>

src/main/resources/static/favicon.ico
spring security

@EnableWebFluxSecurity
@Configuration
public class WebSecurityConfig {

    @Bean
    public PasswordEncoder passwordEncoder() {
        return new BCryptPasswordEncoder();
    }

    @Bean
    public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity httpSecurity) {
        return httpSecurity
                .formLogin().and()
                .httpBasic().disable()
                .authorizeExchange()
                .pathMatchers("/", "/login", "/signup").permitAll()
                .pathMatchers(HttpMethod.POST, "/api/users").permitAll()
                .pathMatchers("/favicon.ico").permitAll()
                .pathMatchers(HttpMethod.GET, "/api/users/**").hasRole("ADMIN")
                .anyExchange().authenticated()
                .and()
                .build();
    }
}

Spring Boot custom favicon.ico not showing

11 Answers11