{"id":18647660,"url":"https://github.com/artcom/topic-browser","last_synced_at":"2025-10-15T23:32:27.487Z","repository":{"id":34843844,"uuid":"153763320","full_name":"artcom/topic-browser","owner":"artcom","description":null,"archived":false,"fork":false,"pushed_at":"2023-03-14T18:16:44.000Z","size":2761,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-05-17T19:37:51.089Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/artcom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2018-10-19T10:03:52.000Z","updated_at":"2021-12-18T10:54:44.000Z","dependencies_parsed_at":"2025-05-17T19:42:45.734Z","dependency_job_id":null,"html_url":"https://github.com/artcom/topic-browser","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"purl":"pkg:github/artcom/topic-browser","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artcom%2Ftopic-browser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artcom%2Ftopic-browser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artcom%2Ftopic-browser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artcom%2Ftopic-browser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/artcom","download_url":"https://codeload.github.com/artcom/topic-browser/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artcom%2Ftopic-browser/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279128624,"owners_count":26109799,"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","status":"online","status_checked_at":"2025-10-15T02:00:07.814Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-07T06:27:21.098Z","updated_at":"2025-10-15T23:32:27.473Z","avatar_url":"https://github.com/artcom.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Topic Browser\n\nThis project provides a web frontend for retained topics served by the [HiveMQ Retained Message Query Plugin](https://github.com/artcom/hivemq-retained-message-query-plugin).\n\n## Setup\n\nThe topic browser can be configured either with env variables or with a config.json file, which needs to be served beside the sources. Provide Username and password, if the broker is used with the [HiveMQ file RBAC extension](https://www.hivemq.com/extension/file-rbac-extension/).\n\n### Env variables\n\n```bash\nWS_BROKER_URI=\"\u003cws_broker_uri\u003e\"\nHTTP_BROKER_URI=\"\u003chttp_broker_uri\u003e\"\nUSERNAME=\"\u003cusername\u003e\"\nPASSWORD=\"\u003cpassword\u003e\"\n```\n\n### Config file\n\n```json\n{\n  \"wsBrokerUri\": \"\u003cws_broker_uri\u003e\",\n  \"httpBrokerUri\": \"\u003chttp_broker_uri\u003e\",\n  \"username\": \"\u003cusername\u003e\",\n  \"password\": \"\u003cpassword\u003e\"\n}\n```\n\n## Local Development Server\n\nCopy `config.json.template` into `public/config.json` and edit properties or use env variables.\n\nFor production build test `npm run start`, copy `config.json.template` into `dist/config.json` and edit properties or use env variables.\n\n## Deployment\n\n### As a Dokku service\n\nThe service can be deployed to Dokku using the Node.js buildpack.\n\n- add dokku server as remote\n```bash\ngit remote add \u003cname\u003e dokku@\u003cserver\u003e:topic-browser\n```\n\n- on first deployment\n```bash\nssh dokku@\u003cserver\u003e apps:create topic-browser\n```\n\n- set configuration\n```bash\nssh dokku@\u003cserver\u003e config:set topic-browser HTTP_BROKER_URI=\u003chttp_broker_uri\u003e WS_BROKER_URI=\u003cws_broker_uri\u003e\n```\n\n- deploy to server\n```bash\ngit push \u003cname\u003e master\n```\n\n### As static from a web server\n\n- Build\n```bash\nnpm run build\n```\n\n- Configure\n\nAdd a `dist/config.json` file with properties as in `config.json.template`\n\n- Serve\n\nServe the `dist` folder.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartcom%2Ftopic-browser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fartcom%2Ftopic-browser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartcom%2Ftopic-browser/lists"}