keycloak-scim/server_installation/topics/operating-mode/standalone.adoc

45 lines
1.8 KiB
Text
Raw Normal View History

2016-04-30 04:39:32 +00:00
2016-04-21 20:18:15 +00:00
[[_standalone-mode]]
=== Using standalone mode
2016-04-21 16:36:12 +00:00
2017-08-28 12:50:14 +00:00
Standalone operating mode is only useful when you want to run one, and only one {project_name} server instance.
2016-04-29 16:09:09 +00:00
It is not usable for clustered deployments and all caches are non-distributed and local-only. It is not recommended that
2016-04-22 20:02:59 +00:00
you use standalone mode in production as you will have a single point of failure. If your standalone mode server goes down,
2017-08-28 12:50:14 +00:00
users will not be able to log in. This mode is really only useful to test drive and play with the features of {project_name}
2016-04-21 16:36:12 +00:00
==== Booting in standalone mode
2016-04-21 16:36:12 +00:00
When running the server in standalone mode, there is a specific script you need to boot the server depending on your
2016-04-21 16:36:12 +00:00
operating system. These scripts live in the _bin/_ directory of the server distribution.
.Standalone Boot Scripts
2017-08-28 12:50:14 +00:00
image:{project_images}/standalone-boot-files.png[]
2016-04-21 16:36:12 +00:00
To boot the server:
.Linux/Unix
[source]
----
$ .../bin/standalone.sh
----
.Windows
[source]
----
> ...\bin\standalone.bat
----
==== Standalone configuration
2016-04-21 16:36:12 +00:00
2017-08-28 12:50:14 +00:00
The bulk of this guide walks you through how to configure infrastructure level aspects of {project_name}. These
aspects are configured in a configuration file that is specific to the application server that {project_name} is a
derivative of. In the standalone operation mode, this file lives in _.../standalone/configuration/standalone.xml_. This file
2017-08-28 12:50:14 +00:00
is also used to configure non-infrastructure level things that are specific to {project_name} components.
2016-04-21 16:36:12 +00:00
.Standalone Config File
2017-08-28 12:50:14 +00:00
image:{project_images}/standalone-config-file.png[]
2016-04-21 16:36:12 +00:00
2016-04-29 16:09:09 +00:00
WARNING: Any changes you make to this file while the server is running will not take effect and may even be overwritten
2018-01-26 14:52:39 +00:00
by the server. Instead use the command line scripting or the web console of {appserver_name}. See
2017-08-28 12:50:14 +00:00
the link:{appserver_admindoc_link}[_{appserver_admindoc_name}_] for more information.