
:guide-id: welcome-theme
:guide-title: Customizing the Welcome Theme
:guide-summary: Learn how to customize the welcome theme.
:guide-priority: 60
:guide-tile-visible: true
:version: 26.3.4

include::../attributes.adoc[]

[[welcome-theme]]
= Customizing the Welcome Theme

ifeval::["" == "true"]
WARNING: This {section} is describing a feature which is currently in preview.
ifeval::["" == ""]
Please provide your feedback while we’re continuing to work on this.
endif::[]
ifeval::["" != ""]
Please provide your feedback by link:[joining this discussion] while we’re continuing to work on this.
endif::[]
endif::[]


The welcome theme is the web page that is served when you request the default page from the {project_name} server.  For instance, if your server is deployed on your local machine at port 8080, http://localhost:8080 serves the welcome theme.

By default, the welcome theme is only used to create the initial temporary admin user.  Once that user is created, whenever users navigate to the welcome theme, they are redirected to the Admin Console.  However, this behavior can be changed and the welcome theme can be completely customized or replaced.

Since the welcome theme is not associated with a realm, it cannot be selected in the admin console like other themes.

To change the welcome theme, create and deploy a new welcome theme as described in <<_creating-a-theme,Creating a theme>>.  Then, start the {project_name} server using the `+spi-theme--welcome-theme+` option.
[source,bash]
----
bin/kc.[sh|bat] start --spi-theme--welcome-theme=custom-theme
----

