keycloak-themes - GitLite

KO | EN

gitlite — search

#hacktoberfest #llm #golang #machine-learning #rust #deep-learning #docker #nodejs #macos #awesome-list #pytorch #security #mcp #open-source

keycloak-themes

(★ 70)

Keycloak Themes

파일 탐색기

최종 버전 다운로드 (.zip)

파일 수가 많아 일부만 표시됩니다. 전체 파일은 위 다운로드 버튼으로 확인해 주세요.

- - standalone-ha.boot.xml
  - standalone-ha.initial.xml
  - standalone-ha.last.xml
- application-roles.properties
- application-users.properties
- logging.properties
- mgmt-groups.properties
- mgmt-users.properties
- standalone-ha.xml
- standalone.xml
- base.jar
- genny.jar
- genny_base.jar
- internmatch.jar
- keycloak-preview.jar
- keycloak.jar
- lojing-theme.jar
- lojing.jar
- mentormatch.jar
- mentormatchv12.jar
- pcss.jar
- stt.jar
- sttNew.jar
- .DS_Store
- README.txt
.DS_Store
.gitignore
docker-compose.yml
LICENSE
package-all.sh
package.sh
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/genny-project/keycloak-themes

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd keycloak-themes

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.

docker compose up -d --build

정의된 모든 컨테이너(서버, DB 등)를 한 번에 빌드하고 백그라운드에서 실행합니다.

✅ 터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Keycloak Themes

Keycloak Themes used by the Genny system.

## Contents
- [Overview](#Overview)
- [Developing Themes](#Developing-Themes)
- [Changelog](#Changelog)

## Overview
Implementation of Keycloak Themes for use by the genny system.

## Developing Themes
### Getting Started
To run keycloak on your machine, navigate to the directory and run the following command:

`docker-compose up -d`

Keycloak instance should now be running on `http://localhost:8080/`

To stop the instance of keycloak, run the following command:

`docker-compose down`

### Creating a Theme
To create a new theme, following these steps:

#### 1. Copy /themes/genny directory and change the directory name

#### 2. Change the logo or name

The file `/login/theme.properties` has the following lines that can be edited:

- projectName (string: any): The name of the project that will be displayed in the heading.
- projectLogo (string: image url): The url of the logo that will be displayed in the heading.
- displayProjectName (bool): If the name will be displayed.
- displayProjectLogo (bool): If the logo will be displayed.

#### 3. Change the colors

The file `/login/resources/css/login.css` has the following colours defined:

- PRIMARY COLOUR: The main colour used in the theme. Will be applied to the header background, buttons, input borders, the subheading text, and links.
- ON PRIMARY COLOUR: The color that will be used for the project name, if any.

Change all of the instances of the colour in those code blocks to the desired colour.

#### 4. Change the background image

The file `/login/resources/css/login.css` has the following image defined:

- BACKGROUND IMAGE: The main image used for the background. You can edit the file path to a new image you place in the directory `/login/resources/img/`, or you can replace the image `background1.jpg` with your new image.

---

## Deploying to production

To deploy your new or updated themes to the production keycloak server:

Package the Jar file:

`./package.sh <theme-name>`

SSH into the production server:

`ssh ubuntu@keycloak11`

Locate the repo and pull changes:

`cd keycloak-themes`

`git pull`

Copy the Jar to the docker container:

`docker cp <theme-name>.jar <keycloak-container>:/opt/jboss/keycloak/standalone/deployments`

You should now see your themes in the admin console of keycloak.

**Note:**

Alternatively you can package all themes at once using:

`./package-all.sh`

## Changelog

* Initial Test of updated Themes.
* Added documentation.
* Added packaging script
* Updated package.json