Code Monkey home page Code Monkey logo

keycloak-web's Introduction

Sources for keycloak.org

Can be built locally from IDE by running AutoBuilder main method or with Maven by running:

mvn clean install

After the build is completed open target/web/index.html in your favourite web browser.

There's also an auto-builder utility that watches the filesystem and continuously rebuilds the website. This can be very useful when working on the website, especially making stylesheet changes, etc. This can be run from your IDE by running AutoBuilder, or from the command-line with:

mvn -Pauto-run exec:java

To serve the website locally with a web browser specify the base URL with KC_URL:

export KC_URL=http://localhost:8000
mvn install

Finally, when building the website to be published you need to include -Dpublish. This should usually not be done manually though as there is a GitHub Action that takes care of building and publishing to https://github.com/keycloak/keycloak.github.io.

Server and Operator guides

Server and Operator guide sources are located at https://github.com/keycloak/keycloak/tree/main/docs/guides and are retrieved as a Maven dependency. By default the latest released version is used, but if you want to build the website with the latest guides from main first build the guides:

git clone https://github.com/keycloak/keycloak
cd keycloak
mvn -pl docs clean install

Then you can build the website with the 999.0.0-SNAPSHOT version:

cd keycloak-web
mvn clean install -Dversion.keycloak=999.0.0-SNAPSHOT

keycloak-web's People

Contributors

stianst avatar keycloak-bot avatar github-actions[bot] avatar ahus1 avatar sebastienblanc avatar abstractj avatar mposolda avatar hmlnarik avatar dependabot[bot] avatar andreatp avatar vramik avatar dguhr avatar yzeng25 avatar andymunro avatar vmuzikar avatar thomasdarimont avatar pedroigor avatar lucafilipozzi avatar wadahiro avatar sventorben avatar dotbr avatar vinodanandan avatar sbusch avatar cornelinux avatar immanuelfodor avatar jkroepke avatar mabartos avatar mhuin avatar dasniko avatar alechenninger avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.