Welcome to the Infinispan Console, the front-end application for the web console of the new Infinispan Server 15.x. This web application is built using Patternfly 5 and React 18.
Before you start using the Infinispan Console, please ensure you have a standalone Infinispan server running locally. The Infinispan server exposes the REST API that is utilized by this console.
In production environments, this console is bundled as a dependency using Maven. This dependency is then added to the Infinispan server bundle, making the console accessible from the server in production.
To run the latest release version using Docker, you can use the following commands:
docker run -it --rm -p 11222:11222 -e USER="admin" -e PASS="pass" infinispan/server
Alternatively, you can use the identities.batch
script running from the scripts
folder:
docker run -v $(pwd):/user-config -e IDENTITIES_BATCH="/user-config/identities.batch" -p 11222:11222 infinispan/server
You can also download the Infinispan server directly from the Infinispan website
To quickly get started with the Infinispan Console, follow these steps:
git clone https://github.com/infinispan/infinispan-console # clone the project
cd infinispan-console # navigate into the project directory
npm install # install infinispan-console dependencies
npm run start:dev # start the development server
Here are some useful development scripts for working with the Infinispan Console:
npm install
npm run start:dev
npm run build
npm run test
npm run lint
npm run format
npm run bundle-profile:analyze
By default, Console in development mode looking for the Infinispan Server REST URL at the http:\\localhost:11222\v2\rest
It's possible to replace host and port URL connection with INFINISPAN_SERVER_URL
environment variable which will be added to the REST endpoint
This console is built and released as a Maven dependency used in the infinispan server.
mvn clean install
Unit test run by default. To skip them use 'skipTests' property.
mvn clean install -DskipTests
Integration tests don't run by default locally. They always run in CI.
To run Cypress integration tests locally, follow these steps:
npm run build # build the console
./run-server-for-e2e-container.sh # will run the latest image of Infinispan for this branch version and the built console
npm run cy:run # will run cypress locally
Generated with Favicon generator
We are using Weblate for translating the Infinispan Console into different languages. Weblate is a web-based translation platform that streamlines the translation process and allows collaboration among contributors.
You can access the translation project for Infinispan Console on Weblate here. If you're interested in contributing translations or improving existing ones, feel free to join the Weblate project and start translating.
Thank you for your contributions in making the Infinispan Console accessible to a broader audience!
You can disable security in the REST API in the infinispan.xml
file of the server you are running.
Remove the security-realm="default"
from the endpoints
<endpoints socket-binding="default">
<hotrod-connector name="hotrod"/>
<rest-connector name="rest"/>
</endpoints>
Default security of the server uses credential authentication.
If you run a server without any user or password, the 'Support' popup should be displayed in the welcome page.
docker-compose up
admin/adminPassword
credentials. Keycloak redirects you to the dev console.