prashantbabar002 / mb_emt

0 stars 0 forks source link

Assess Keycloak installation for local development #2

Closed prashantbabar002 closed 1 month ago

prashantbabar002 commented 1 month ago

As a Developer I need to have instructions documented for installation of keycloak So that we can use it in development systems

Acceptance Criteria

  1. Keycloak running locally
  2. share connection string details

    Notes

We will be using common settings so that java code can use those from configurations. Realm - mybogie userName/pwd - Served on demand

prashantbabar002 commented 1 month ago

Doc was created while setting up keycloak on debian. Can be used to set up in same manner for wsl/linux distro

1. Get SSH access to debian/ubuntu instance
    this doc is tested with debian config :
        prashant@mbckdeb01:~$ lsb_release -a
        No LSB modules are available.
        Distributor ID: Debian
        Description:    Debian GNU/Linux 11 (bullseye)
        Release:        11
        Codename:       bullseye
    Make sure port 8080 is open
2. Install open-jdk-jre 17
    Update apt : 
        prashant@mbckdeb01:~$ sudo apt update && sudo apt upgrade
    install jre : 
        prashant@mbckdeb01:~$ sudo apt install openjdk-17-jre
    check java version : 
        prashant@mbckdeb01:~$ java -version
        OUTPUT :    openjdk version "17.0.11" 2024-04-16
                    OpenJDK Runtime Environment (build 17.0.11+9-Debian-1deb11u1)
                    OpenJDK 64-Bit Server VM (build 17.0.11+9-Debian-1deb11u1, mixed mode, sharing)
3. Install keycloak
    create app directories in home directory
        mkdir apps
        cd apps
        mkdir kc
        cd kc
    get and extract keycloak tar.gz
        wget https://github.com/keycloak/keycloak/releases/download/24.0.4/keycloak-24.0.4.tar.gz
        tar -xvzf keycloak-24.0.4.tar.gz
        cd keycloak-24.0.4/
4. Setup admin user and http so can be accessed remotely 
    Export variables to set default admin credentials
        prashant@mbckdeb01:~/apps/kc/keycloak-24.0.4$ export KEYCLOAK_ADMIN=mbkcadm
        prashant@mbckdeb01:~/apps/kc/keycloak-24.0.4$ export KEYCLOAK_ADMIN_PASSWORD=XXXXXX
    Start keycloak
        prashant@mbckdeb01:~/apps/kc/keycloak-24.0.4$ ./bin/kc.sh start-dev         wait for server to start
    Setup http true(Connect with ssh in new terminal)
        prashant@mbckdeb01:~/apps/kc/keycloak-24.0.4$ ./bin/kcadm.sh config credentials --server http://localhost:8080 --realm master --user mbkcadm –-password DZvEzGkE3v
                                                                                    Enter PWD it should login without error
        ./bin/kcadm.sh update realms/master -s sslRequired=NONE                     No error Should come up         
5.Make sure we can login remotely with username and pwd
            http://5XX2.XX.XX.XXXX:8080/
6. For every realm 
    repeate step 4  -- 'Setup http true' with same command for config credentials but change realm for setting ssl required
        prashant@mbckdeb01:~/apps/kc/keycloak-24.0.4$ ./bin/kcadm.sh config credentials --server http://localhost:8080 --realm master --user mbkcadm –-password XXXXXXXXXX
                                                                                    Enter PWD it should login without error
        ./bin/kcadm.sh update realms/mybogie -s sslRequired=NONE                        No error Should come up