[[index]]
= WildFly Documentation
:ext-relative: {outfilesuffix}

ifdef::env-github[]
:tip-caption: :bulb:
:note-caption: :information_source:
:important-caption: :heavy_exclamation_mark:
:caution-caption: :fire:
:warning-caption: :warning:
endif::[]

:toc!:

image:images/splash_wildflylogo_small.png[WildFly, align="center"]

Welcome to the WildFly documentation. The documentation for WildFly is
split into multiple categories:

* _Installation Guides_ for those wanting to understand the flexibility 
that WildFly offers when it comes to server installation and application deployment.

* _Administrator Guides_ for those wanting to understand how to install
and configure the server.

* _Developer Guides_ for those wanting to understand how to develop
applications for the server.

* _Migration Guide_ for information related to migrating away from removed features.

* _Model Reference_ for those wanting information about all
of configuration options available via the WildFly management model.

* _Security Guide_ for those wanting to understand how to secure the WildFly server and applications.

* _Client Guide_ for those wanting to understand configuration of WildFly clients.

* _Quickstarts_ for those wanting to jump into code and start using WildFly.

[[installation-guides]]
== Installation Guides

* The link:WildFly_and_WildFly_Preview{outfilesuffix}[WildFly and WildFly Preview] document introduces the different
appserver variants produced by the WildFly project: the standard WildFly variant and the early-look tech preview
WildFly Preview variant.
* The link:Installation_Guide{outfilesuffix}[Installation Guide] helps you identify
the kind of WildFly installation that best fits your application's deployment needs:
a WildFly zip installation, a WildFly server provisioned with Galleon or a WildFly bootable JAR.

* The link:WildFly_Maven_Plugin_Guide{outfilesuffix}[WildFly Maven Plugin Guide] shows you how to package a WildFly server along with your application as part of your application's Maven build.
* The link:Bootable_Guide{outfilesuffix}[Bootable JAR Guide] shows you how to package your application and the WildFly server
into a bootable JAR.

* The link:Galleon_Guide{outfilesuffix}[Galleon Provisioning Guide] shows you how to 
provision a customized WildFly server using Galleon.

* The link:Getting_Started_on_OpenShift{outfilesuffix}[Getting Started with WildFly on OpenShift Guide] shows you how to use WildFly on OpenShift.

[[administrator-guides]]
== Administrator Guides

* The link:Getting_Started_Guide{outfilesuffix}[Getting Started Guide] shows you
how to install and start the server, how to configure logging, how to
deploy an application, how to deploy a datasource, and how to get
started using the command line interface and web management interface.

* The link:Admin_Guide{outfilesuffix}[Admin Guide] provides detailed information
on using the CLI and web management interface, shows you how to administer a WildFly managed
domain, and shows you how to configure key subsystems.

* The link:High_Availability_Guide{outfilesuffix}[High Availability Guide] shows
you how to create a cluster, how to configure the web container and Jakarta Enterprise Beans
container for clustering and how to configure load balancing
and failover.

* The link:wildscribe[WildFly model reference] provides information about all standalone server and managed domain
configuration options, using information generated directly from the WildFly management model.

[[developer-guides]]
== Developer Guides

* The link:Getting_Started_Developing_Applications_Guide{outfilesuffix}[Getting
Started Developing Applications Guide] shows you how to build Jakarta EE
applications and deploy them to WildFly. The guide starts by showing you
the simplest _helloworld_ application using just Servlet and Jakarta Contexts and Dependency Injection, and
then adds in Jakarta Faces, persistence and transactions, Jakarta Enterprise Beans, Bean Validation,
RESTful web services and more. Finally, you'll get the opportunity to create
your own skeleton project. Each tutorial is accompanied by a quickstart,
which contains the source code, deployment descriptors and a Maven based
build.

* The link:Developer_Guide{outfilesuffix}[Developer Guide] takes
you through every deployment descriptor and every annotation offered by
WildFly.

* The link:Extending_WildFly{outfilesuffix}[Extending WildFly] guide walks you
through creating a new WildFly subsystem extension, in order to add more
functionality to WildFly, and shows how to test it before plugging it
into WildFly.

* The link:Testsuite{outfilesuffix}[WildFly Testsuite] guide walks you through testing WildFly.

* The link:Hacking_On_WildFly{outfilesuffix}[Hacking on WildFly] guide walks you through contributing to WildFly.

== Migration Guide

* The link:Migration_Guide{outfilesuffix}[Migration Guide] describes alternative options for
features which have been removed from WildFly.

== Security Guide

* The link:WildFly_Elytron_Security{outfilesuffix}[WildFly Elytron Security] guide walks you through WildFly's new security layer.

== Client Guide

* The link:Client_Guide{outfilesuffix}[WildFly Client Configuration] guide walks you through the new WildFly client and how to use it.

[[quickstarts]]
== Quickstarts

* The link:Quickstarts{outfilesuffix}[WildFly Quickstarts] describe how to use the WildFly examples, which introduce a particular technology or feature of the application server.

[[more-resources]]
== More Resources

* link:Glossary.html[Glossary]
* https://wildfly.org[project page]
* https://issues.redhat.com/browse/WFLY[issue tracker]
* https://groups.google.com/g/wildfly[user forum]
* https://github.com/wildfly/wildfly/[Source code at GitHub]
