{"id":13475867,"url":"https://github.com/lmenezes/cerebro","last_synced_at":"2025-05-14T09:06:25.161Z","repository":{"id":37678090,"uuid":"54560347","full_name":"lmenezes/cerebro","owner":"lmenezes","description":null,"archived":false,"fork":false,"pushed_at":"2024-02-12T09:56:27.000Z","size":3677,"stargazers_count":5583,"open_issues_count":207,"forks_count":718,"subscribers_count":187,"default_branch":"main","last_synced_at":"2025-04-11T03:38:10.135Z","etag":null,"topics":["admin","elasticsearch"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lmenezes.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","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":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-03-23T13:05:09.000Z","updated_at":"2025-04-09T08:10:29.000Z","dependencies_parsed_at":"2024-01-15T09:05:51.553Z","dependency_job_id":"a5b6f2f1-880a-40cd-b947-434703869d8d","html_url":"https://github.com/lmenezes/cerebro","commit_stats":null,"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmenezes%2Fcerebro","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmenezes%2Fcerebro/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmenezes%2Fcerebro/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmenezes%2Fcerebro/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lmenezes","download_url":"https://codeload.github.com/lmenezes/cerebro/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254110374,"owners_count":22016391,"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":["admin","elasticsearch"],"created_at":"2024-07-31T16:01:24.254Z","updated_at":"2025-05-14T09:06:25.135Z","avatar_url":"https://github.com/lmenezes.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","others","Elasticsearch plugins","ElasticSearch-Manage","Monitoring"],"sub_categories":["Cluster"],"readme":"Cerebro\n------------\n[![Docker Pulls](https://img.shields.io/docker/pulls/lmenezes/cerebro.svg)](https://hub.docker.com/r/lmenezes/cerebro)\n![build](https://github.com/lmenezes/cerebro/workflows/build/badge.svg?branch=master)\n\ncerebro is an open source(MIT License) elasticsearch web admin tool built using Scala, Play Framework, AngularJS and Bootstrap.\n\n### Requirements\n\ncerebro needs Java 11 or newer to run.\n\n### Installation\n- Download from [https://github.com/lmenezes/cerebro/releases](https://github.com/lmenezes/cerebro/releases)\n- Extract files\n- Run bin/cerebro(or bin/cerebro.bat if on Windows)\n- Access on http://localhost:9000\n\n### Chocolatey (Windows)\n\nYou can install `cerebro` using [Chocolatey](https://chocolatey.org/):\n\n```sh\nchoco install cerebro-es\n```\n\nPackage creates windows service ```cerebro```.\nAccess on http://localhost:9000\n\n### Docker\n\nYou can find the official docker images in the official [docker hub repo](https://hub.docker.com/r/lmenezes/cerebro/).\n\nVisit [cerebro-docker](https://github.com/lmenezes/cerebro-docker) for further information. \n\n### Configuration\n\n#### HTTP server address and port\nYou can run cerebro listening on a different host and port(defaults to 0.0.0.0:9000):\n\n```\nbin/cerebro -Dhttp.port=1234 -Dhttp.address=127.0.0.1\n```\n\n#### LDAP config\n\nLDAP can be configured using environment variables. If you typically run cerebro using docker,\nyou can pass a file with all the env vars. The file would look like:\n\n```bash\n# Set it to ldap to activate ldap authorization\nAUTH_TYPE=ldap\n\n# Your ldap url\nLDAP_URL=ldap://exammple.com:389\n\nLDAP_BASE_DN=OU=users,DC=example,DC=com\n\n# Usually method should  be \"simple\" otherwise, set it to the SASL mechanisms\nLDAP_METHOD=simple\n\n# user-template executes a string.format() operation where\n# username is passed in first, followed by base-dn. Some examples\n#  - %s =\u003e leave user untouched\n#  - %s@domain.com =\u003e append \"@domain.com\" to username\n#  - uid=%s,%s =\u003e usual case of OpenLDAP\nLDAP_USER_TEMPLATE=%s@example.com\n\n# User identifier that can perform searches\nLDAP_BIND_DN=admin@example.com\nLDAP_BIND_PWD=adminpass\n\n# Group membership settings (optional)\n\n# If left unset LDAP_BASE_DN will be used\n# LDAP_GROUP_BASE_DN=OU=users,DC=example,DC=com\n\n# Attribute that represent the user, for example uid or mail\n# LDAP_USER_ATTR=mail\n\n# If left unset LDAP_USER_TEMPLATE will be used\n# LDAP_USER_ATTR_TEMPLATE=%s\n\n# Filter that tests membership of the group. If this property is empty then there is no group membership check\n# AD example =\u003e memberOf=CN=mygroup,ou=ouofthegroup,DC=domain,DC=com\n# OpenLDAP example =\u003e CN=mygroup\n# LDAP_GROUP=memberOf=memberOf=CN=mygroup,ou=ouofthegroup,DC=domain,DC=com\n\n```\n\nYou can the pass this file as argument using:\n\n```bash\n docker run -p 9000:9000 --env-file env-ldap  lmenezes/cerebro\n```\n\nThere are some examples of configuration in the [examples folder](./examples).\n\n#### Other settings\n\nOther settings are exposed through the **conf/application.conf** file found on the application directory.\n\nIt is also possible to use an alternate configuration file defined on a different location:\n\n```\nbin/cerebro -Dconfig.file=/some/other/dir/alternate.conf\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flmenezes%2Fcerebro","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flmenezes%2Fcerebro","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flmenezes%2Fcerebro/lists"}