libre.sh/keycloak-scim
4
0
Fork 0
Code Issues 15 Pull requests Releases 1 Activity Actions

KEYCLOAK-10357 Fix descriptions of nonexistent deploy/ directory

Browse source
This commit is contained in:
k-tamura 2019-05-24 12:53:33 +09:00 committed by Stian Thorgersen
parent 701f62f277
commit 5519fe7bc0
3 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
server_development/topics/user-storage/migration.adoc
View file

@ -83,7 +83,7 @@ So, knowing this there are different approaches you can take.
. You can remove the earlier provider in your earlier {project_name} deployment. This will remove the local linked copies . You can remove the earlier provider in your earlier {project_name} deployment. This will remove the local linked copies
of all users you imported. Then, when you upgrade {project_name}, just deploy and configure your new provider for your realm. of all users you imported. Then, when you upgrade {project_name}, just deploy and configure your new provider for your realm.
. The second option is to write your new provider making sure it has the same provider ID: `UserStorageProviderFactory.getId()`. . The second option is to write your new provider making sure it has the same provider ID: `UserStorageProviderFactory.getId()`.
Make sure this provider is in the `deploy/` directory of the new {project_name} installation. Boot the server, and have Make sure this provider is in the `standalone/deployments/` directory of the new {project_name} installation. Boot the server, and have
the built-in migration script convert from the earlier data model to the later data model. In this case all your earlier linked imported the built-in migration script convert from the earlier data model to the later data model. In this case all your earlier linked imported
users will work and be the same. users will work and be the same.

2
server_development/topics/user-storage/packaging.adoc
View file

@ -1,7 +1,7 @@
=== Packaging and Deployment === Packaging and Deployment
User Storage providers are packaged in a JAR and deployed or undeployed to the {project_name} runtime in the same way you would deploy something in the {appserver_name} application server. You can either copy the JAR directly to the `deploy/` directory of the server, or use the JBoss CLI to execute the deployment. User Storage providers are packaged in a JAR and deployed or undeployed to the {project_name} runtime in the same way you would deploy something in the {appserver_name} application server. You can either copy the JAR directly to the `standalone/deployments/` directory of the server, or use the JBoss CLI to execute the deployment.
In order for {project_name} to recognize the provider, you need to add a file to the JAR: `META-INF/services/org.keycloak.storage.UserStorageProviderFactory`. This file must contain a line-separated list of fully qualified classnames of the `UserStorageProviderFactory` implementations: In order for {project_name} to recognize the provider, you need to add a file to the JAR: `META-INF/services/org.keycloak.storage.UserStorageProviderFactory`. This file must contain a line-separated list of fully qualified classnames of the `UserStorageProviderFactory` implementations:

2
server_development/topics/user-storage/simple-example.adoc
View file

@ -257,7 +257,7 @@ The class files for our provider implementation should be placed in a jar. You
org.keycloak.examples.federation.properties.FilePropertiesStorageFactory org.keycloak.examples.federation.properties.FilePropertiesStorageFactory
---- ----
Once you create the jar you can deploy it using regular {appserver_name} means: copy the jar into the `deploy/` directory or using the JBoss CLI. Once you create the jar you can deploy it using regular {appserver_name} means: copy the jar into the `standalone/deployments/` directory or using the JBoss CLI.
==== Enabling the Provider in the Administration Console ==== Enabling the Provider in the Administration Console