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

Fixes outdated Readme

Browse source 
also changes the general readme and the themes folders readme, bc invoking the shell-script without arguments leads to help now instead of starting

Closes #9501
This commit is contained in:
Dominik Guhr 2022-01-11 12:05:41 +01:00 committed by Pedro Igor
parent a93ab357e5
commit 4436fb3a18
3 changed files with 20 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
distribution/server-x-dist/src/main/README.md
View file

@ -1,14 +1,26 @@
Keycloak.X Keycloak.X
========== ==========
To run on Linux/Unix: To get help configuring Keycloak via the CLI, run:
on Linux/Unix:
$ bin/kc.sh $ bin/kc.sh
To run on Windows: on Windows:
$ bin\kc.bat $ bin\kc.bat
To try Keycloak out in development mode, run:
on Linux/Unix:
$ bin/kc.sh start-dev
on Windows:
$ bin\kc.bat start-dev
After the server boots, open http://localhost:8080 in your web browser. The welcome page will indicate that the server is running. After the server boots, open http://localhost:8080 in your web browser. The welcome page will indicate that the server is running.
To get started, check the [Server Administration Guide](https://www.keycloak.org/docs/latest/server_admin). To get started, check the [Server Administration Guide](https://www.keycloak.org/docs/latest/server_admin).

6
distribution/server-x-dist/src/main/content/providers/README.md
View file

@ -1,10 +1,10 @@
Installing Custom Providers Installing Custom Providers
=========================== ===========================
You should add to this directory your custom provider JAR files. Add your custom provider JAR files in this directory.
Once you have your providers in this directory you should run the following command to complete the installation: Once you have your providers in this directory, run the following command to complete the installation:
``` ```
${kc.home.dir}/bin/kc.sh config ${kc.home.dir}/bin/kc.sh build
``` ```

6
distribution/server-x-dist/src/main/content/themes/README.md
View file

@ -4,10 +4,10 @@ Creating Themes
Themes are used to configure the look and feel of login pages and the account management console. Themes are used to configure the look and feel of login pages and the account management console.
Custom themes packaged in a JAR file should be deployed to the `${kc.home.dir}/providers` directory and you should run Custom themes packaged in a JAR file should be deployed to the `${kc.home.dir}/providers` directory and you should run
the `config` command to install them prior to running the server. the `build` command to install them prior to running the server.
You should also be able to create your custom themes in this directory, directly. Themes within this directory do not require You are also able to create your custom themes in this directory, directly. Themes within this directory do not require
the `config` command to install them. the `build` command to install them.
When running the server in development mode, themes are not cached so that you can easily work on them without any need to restart When running the server in development mode, themes are not cached so that you can easily work on them without any need to restart
the server when making changes. the server when making changes.