{"id":43507562,"url":"https://github.com/zextras/carbonio-catalog-service","last_synced_at":"2026-04-10T16:03:27.352Z","repository":{"id":309536806,"uuid":"844466878","full_name":"zextras/carbonio-catalog-service","owner":"zextras","description":"Carbonio services catalog","archived":false,"fork":false,"pushed_at":"2026-01-26T14:24:58.000Z","size":278,"stargazers_count":0,"open_issues_count":8,"forks_count":1,"subscribers_count":7,"default_branch":"devel","last_synced_at":"2026-01-27T03:20:16.026Z","etag":null,"topics":["carbonio-component"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zextras.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-08-19T10:17:28.000Z","updated_at":"2026-01-20T12:21:23.000Z","dependencies_parsed_at":"2025-12-05T14:01:23.526Z","dependency_job_id":null,"html_url":"https://github.com/zextras/carbonio-catalog-service","commit_stats":null,"previous_names":["zextras/carbonio-catalog-service"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/zextras/carbonio-catalog-service","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zextras%2Fcarbonio-catalog-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zextras%2Fcarbonio-catalog-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zextras%2Fcarbonio-catalog-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zextras%2Fcarbonio-catalog-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zextras","download_url":"https://codeload.github.com/zextras/carbonio-catalog-service/tar.gz/refs/heads/devel","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zextras%2Fcarbonio-catalog-service/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29046176,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-03T10:09:22.136Z","status":"ssl_error","status_checked_at":"2026-02-03T10:09:16.814Z","response_time":96,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["carbonio-component"],"created_at":"2026-02-03T12:39:25.850Z","updated_at":"2026-02-03T12:39:28.374Z","avatar_url":"https://github.com/zextras.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Carbonio Catalog Service\n\n## How to build ⚙\n\nBuild using maven:\n\n```bash\nmvn clean install\n```\n\n## How to run locally 🚀\n\nThe command below will open a tunnel to a remote VM and start the\napplication locally.\n\n   ```bash\n   HOST=kc-dev1 make run_dev\n   ```\n\nYou can check application is up and running by opening\nhttp://localhost:10000/q/dev-ui\n\n## How to install 🏁\n\nInstall `carbonio-catalog` via apt:\n\n```bash\nsudo apt install carbonio-catalog\n```\n\nor via yum:\n\n```bash\nsudo yum install carbonio-catalog\n```\n\nAfter the installation you must run `pending-setups` to configure it correctly.\n\n## Open-api documentation\n\nThe openapi documentation is updated on every package build. It is located in `src/main/resources/open-api.yaml`.\n\n## Port Forwarding\n\nRun the `tunnel.sh` script to establish a secure tunnel from your local machine to the required services on a remote VM\ncluster.\n\n### Usage\n\nExecute with hostname and optional domain:\n\n```\n./tunnel.sh -n [hostname] [-d domain] \n```\n\n- -n: Hostname of the server.\n- -d: Optional domain, defaults to demo.zextras.io.\n\n### Example\n\n```bash\n./tunnel.sh -n myserver -d example.com \n```\n\n## Makefile Overview\n\nSummary of the available commands:\n\n### Basic\n\n- clean: clean the project, removing all files generated by the previous build.\n- compile: compiles the project without running tests.\n- test: runs the complete Maven build cycle, including tests.\n\n### System Management\n\nBy default, we assume that `carbonio-catalog` will be installed in the same node as consul in the cluster.\nIf you have it installed in a different node (ex: `kc-dev1-mbox`) you can pass `NODE=mbox` variable to\nthe `make sys-*` script.\nYou still need to pass the `HOST=kc-dev1` in order to tell which cluster you want to reach.\n\n- sys-status: Connects via SSH to the specified host and checks the status of carbonio-catalog.\n- sys-stop: Stops the carbonio-catalog service on the remote server.\n- sys-start: Starts the carbonio-catalog service on the remote server.\n\n### Deployment\n\nBy default, we assume that `carbonio-catalog` will be installed in the same node as consul in the cluster.\nIf you have it installed in a different node (ex: `kc-dev1-mbox`) you can pass `NODE=mbox` variable to\nthe `make upload` script.\nYou still need to pass the `HOST=kc-dev1` in order to tell which cluster you want to reach.\n\n- upload: Removes existing artifacts from the carbonio-catalog directory on the remote server and uploads new ones.\n- sys-install: Cleans and compiles the project, then build `.deb` package and install it on remote server.\n- sys-deploy: A comprehensive command that cleans, compiles, stops the system service, uploads new artifacts, and then\n  restarts the service.\n\n### Service Info (multi-node environment)\n\nYou can check in how many nodes are running a specific service and his health status.\n\n```bash\n# from script\n./service_info.sh -s my-service -h kc-dev1\n```\n\n```bash\n# from makefile\nexport HOST=kc-dev1\nexport SERVICE_ID=my-service\nmake info\n```\n\n## Copyright and Licensing notices\nAll non-software material (such as, for example, names, images, logos,\nsounds) is owned by Zextras s.r.l. and is licensed under CC-BY-NC-SA\nhttps://creativecommons.org/licenses/by-nc-sa/4.0/.\nWhere not specified, all source files owned by Zextras s.r.l. are licensed\nunder AGPL-3.0-only","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzextras%2Fcarbonio-catalog-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzextras%2Fcarbonio-catalog-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzextras%2Fcarbonio-catalog-service/lists"}