{"id":28385402,"url":"https://github.com/infinispan/infinispan-console","last_synced_at":"2026-04-02T02:44:07.909Z","repository":{"id":37397489,"uuid":"199041238","full_name":"infinispan/infinispan-console","owner":"infinispan","description":"Infinispan Server Web Console","archived":false,"fork":false,"pushed_at":"2025-06-24T13:56:28.000Z","size":6330,"stargazers_count":27,"open_issues_count":57,"forks_count":32,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-06-24T14:48:32.639Z","etag":null,"topics":["console-tool","hacktoberfest","infinispan","infinispan-server","patternfly","react","typescript"],"latest_commit_sha":null,"homepage":"https://infinispan.org/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/infinispan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-07-26T15:33:01.000Z","updated_at":"2025-06-24T13:56:32.000Z","dependencies_parsed_at":"2023-09-23T04:12:38.887Z","dependency_job_id":"564d3c86-e330-4228-8380-01536e41429d","html_url":"https://github.com/infinispan/infinispan-console","commit_stats":null,"previous_names":["infinispan/infinispan-console-ng"],"tags_count":77,"template":false,"template_full_name":null,"purl":"pkg:github/infinispan/infinispan-console","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infinispan%2Finfinispan-console","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infinispan%2Finfinispan-console/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infinispan%2Finfinispan-console/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infinispan%2Finfinispan-console/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/infinispan","download_url":"https://codeload.github.com/infinispan/infinispan-console/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infinispan%2Finfinispan-console/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262014782,"owners_count":23245199,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["console-tool","hacktoberfest","infinispan","infinispan-server","patternfly","react","typescript"],"created_at":"2025-05-30T10:39:38.033Z","updated_at":"2026-04-02T02:44:07.903Z","avatar_url":"https://github.com/infinispan.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Infinispan Console\n\n[![Version](https://img.shields.io/maven-central/v/org.infinispan/infinispan-console?logo=apache-maven\u0026style=for-the-badge)](https://search.maven.org/artifact/org.infinispan/infinispan-console)\n[![License](https://img.shields.io/github/license/infinispan/infinispan-console?style=for-the-badge\u0026logo=apache)](https://www.apache.org/licenses/LICENSE-2.0)\n\n\nWelcome 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](https://www.patternfly.org/get-started/develop) and [React 18](https://react.dev/learn).\n\n## Getting Started\nBefore you start using the Infinispan Console, please ensure you have a standalone Infinispan server running locally. The Infinispan server exposes the [REST API](https://infinispan.org/docs/dev/titles/rest/rest.html) that is utilized by this console.\n\nIn 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.\n\n### Run with Docker\n\nTo run the latest release version using Docker, you can use the following commands:\n\n```bash\n docker run -it --rm -p 11222:11222 -e USER=\"admin\" -e PASS=\"pass\" infinispan/server\n```\nAlternatively, you can use the ```identities.batch``` script running from the ```scripts``` folder:\n\n```bash\ndocker run -v $(pwd):/user-config -e IDENTITIES_BATCH=\"/user-config/identities.batch\" -p 11222:11222 infinispan/server\n```\n\n### Direct download\nYou can also download the Infinispan server directly from the [Infinispan website](https://infinispan.org/download/)\n\n## Quick-start\nTo quickly get started with the Infinispan Console, follow these steps:\n```bash\ngit clone https://github.com/infinispan/infinispan-console # clone the project\ncd infinispan-console # navigate into the project directory\nnpm install # install infinispan-console dependencies\nnpm run start:dev # start the development server\n```\n\n## Development Scripts\n\nHere are some useful development scripts for working with the Infinispan Console:\n\n- Install development/build dependencies: `npm install`\n- Start the development server: `npm run start:dev`\n- Run a production build (outputs to \"dist\" directory): `npm run build`\n- Run the test suite: `npm run test`\n- Run the linter: `npm run lint`\n- Run the code formatter: `npm run format`\n- Launch a tool to inspect the bundle size: `npm run bundle-profile:analyze`\n\nBy default, Console in development mode looking for the Infinispan Server REST URL at the `http:\\\\localhost:11222\\v2\\rest`\n\nIt's possible to replace host and port URL connection with `INFINISPAN_SERVER_URL` environment variable which will be added to the REST endpoint\n\n## Build the Maven dependency\n\nThis console is built and released as a Maven dependency used in the infinispan server.\n```bash\nmvn clean install\n```\n\n## Skip Unit tests\nUnit test run by default. To skip them use 'skipTests' property.\n```bash\nmvn clean install -DskipTests\n```\n\n## Run Cypress IT Tests\nIntegration tests don't run by default locally. They always run in CI.\n\nTo run Cypress integration tests locally, follow these steps:\n\n```shell\nnpm run build # build the console\n./run-server-for-e2e-container.sh # will run the latest image of Infinispan for this branch version and the built console\nnpm run cy:run # will run cypress locally\n```\n\n## Configurations\n* [TypeScript Config](./tsconfig.json)\n* [Webpack Config](./webpack.common.js)\n* [Jest Config](./jest.config.js)\n* [Editor Config](./.editorconfig)\n\n## Favicons\n\nGenerated with [Favicon generator](https://www.favicon-generator.org/)\n\n## Translation\n\nWe 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.\n\nYou can access the translation project for Infinispan Console on Weblate [here](https://hosted.weblate.org/projects/infinispan/infinispan-console/). If you're interested in contributing translations or improving existing ones, feel free to join the Weblate project and start translating.\n\n### How to Contribute Translations\n\n1. Visit the [Weblate project](https://hosted.weblate.org/projects/infinispan/infinispan-console/) for Infinispan Console.\n2. Sign up or log in to your Weblate account.\n3. Choose the language you want to work on from the available languages or add a new language for translation.\n4. Start translating the strings directly on the Weblate interface.\n5. Once you're satisfied with the translations, submit them, and they will be reviewed and integrated into the Infinispan Console.\n\nThank you for your contributions in making the Infinispan Console accessible to a broader audience!\n\n## Code Quality Tools\n* To keep our bundle size in check, we use [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer)\n* To keep our code formatting in check, we use [prettier](https://github.com/prettier/prettier)\n* To keep our code logic and test coverage in check, we use [jest](https://github.com/facebook/jest)\n\n## Securing the Console\n\n### Disabling Security\n\nYou can disable security in the REST API in the `infinispan.xml` file of the server you are running.\nRemove the `security-realm=\"default\"` from the endpoints\n\n```xml\n  \u003cendpoints socket-binding=\"default\"\u003e\n    \u003chotrod-connector name=\"hotrod\"/\u003e\n    \u003crest-connector name=\"rest\"/\u003e\n  \u003c/endpoints\u003e\n```\n\n### Infinispan Authentication\nDefault security of the server uses credential authentication.\n\nIf you run a server without any user or password, the 'Support' popup should be displayed in the welcome page.\n\n### Keycloak\n\n1. Add an alias between 127.0.0.1  keycloak in the 'etc/hosts' file.\n2. Run the Docker compose file under the folder 'keycloak'. It will spin up an Infinispan Server with keycloak realm and Keycloak server.\n\n```shell\ndocker-compose up \n```\n\n3. Run the console in dev mode. When you open the dev console in your browser, Keycloak prompts you for credentials.\n4. Enter the `admin/adminPassword` credentials. Keycloak redirects you to the dev console.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfinispan%2Finfinispan-console","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finfinispan%2Finfinispan-console","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfinispan%2Finfinispan-console/lists"}