{"id":21657259,"url":"https://github.com/zcubbs/hub","last_synced_at":"2025-06-27T20:34:50.675Z","repository":{"id":65349490,"uuid":"514361374","full_name":"zcubbs/hub","owner":"zcubbs","description":"hub is a links \u0026 bookmarks app designed to be simple, lightweight, and easy to use. It relies on a YAML configuration file to define the links and groups. Can be deployed as a container or binary. A Helm chart is also available.","archived":false,"fork":false,"pushed_at":"2024-05-05T14:16:55.000Z","size":318,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-11T22:12:42.930Z","etag":null,"topics":["bookmarks","go","landing-page","links"],"latest_commit_sha":null,"homepage":"","language":"Go","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/zcubbs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":"2022-07-15T18:03:48.000Z","updated_at":"2024-05-05T14:16:29.000Z","dependencies_parsed_at":"2023-10-15T13:21:58.504Z","dependency_job_id":"f92dea9a-d1bd-4c15-8843-62fc0c645c10","html_url":"https://github.com/zcubbs/hub","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcubbs%2Fhub","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcubbs%2Fhub/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcubbs%2Fhub/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcubbs%2Fhub/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zcubbs","download_url":"https://codeload.github.com/zcubbs/hub/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248487684,"owners_count":21112190,"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":["bookmarks","go","landing-page","links"],"created_at":"2024-11-25T09:20:14.464Z","updated_at":"2025-04-11T22:12:47.800Z","avatar_url":"https://github.com/zcubbs.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hub\n\n`hub` is a links \u0026 bookmarks app designed to be simple, lightweight, and easy to use. It relies on a YAML configuration file to define the links and groups. Can be deployed as a container or binary. A Helm chart is also available.\n\n[![tag](https://img.shields.io/github/tag/zcubbs/hub)](https://github.com/zcubbs/hub/releases)\n![Go Version](https://img.shields.io/badge/Go-%3E%3D%201.21-%23007d9c)\n[![GoDoc](https://godoc.org/github.com/zcubbs/hub?status.svg)](https://pkg.go.dev/github.com/zcubbs/hub)\n[![Lint](https://github.com/zcubbs/hub/actions/workflows/lint.yaml/badge.svg)](https://github.com/zcubbs/hub/actions/workflows/lint.yaml)\n[![Scan](https://github.com/zcubbs/hub/actions/workflows/scan.yaml/badge.svg?branch=main)](https://github.com/zcubbs/hub/actions/workflows/scan.yaml)\n![Build Status](https://github.com/zcubbs/hub/actions/workflows/test.yaml/badge.svg)\n[![Go Report Card](https://goreportcard.com/badge/github.com/zcubbs/hub)](https://goreportcard.com/report/github.com/zcubbs/hub)\n[![Contributors](https://img.shields.io/github/contributors/zcubbs/hub)](https://github.com/zcubbs/hub/graphs/contributors)\n[![License](https://img.shields.io/github/license/zcubbs/hub.svg)](./LICENSE)\n\n![](docs/showcase_4.png)\n\n## Installation\n\n\u003e Supported Platforms: `linux_amd64/linux_arm64`.\n\n### From Binary\n\nYou can download the latest release from [here](https://github.com/zcubbs/hub/releases)\n```bash\nhub -config /path/to/config.yaml\n```\n\n### Using Docker\n\n```bash\ndocker run -d \\\n    -p 8000:8000 \\\n    -v /path/to/config.yaml:/app/config.yaml \\\n    ghcr.io/zcubbs/hub:latest\n```\n\n### Using Helm\n\n```bash\nhelm install hub oci://ghcr.io/zcubbs/hub/hub -f /path/to/values.yaml\n```\n\nsee [values.yaml](charts/hub/values.yaml) for the default values.\n\n## Configuration\n\nHuB is configured via a YAML file you can provide to the container/binary. The example configuration is located at [config.yaml](./examples/config.yaml). The following is an example configuration:\n\n```yaml\napp:\n  server:\n    port: \u003cint\u003e             # Application port\n  customHtml: \u003cstring\u003e      # Custom HTML content\n  title: \u003cstring\u003e           # Application title\n  subtitle: \u003cstring\u003e        # Application subtitle\n  logoUrl: \u003cstring\u003e         # URL to the logo image\n  disclaimer: \u003cstring\u003e      # Disclaimer text\n  debug: \u003cbool\u003e             # Debug mode (true/false)\n\ndata:\n  links:                   # Array of main links\n    - caption: \u003cstring\u003e\n      url: \u003cstring\u003e\n      icon: \u003cstring\u003e\n      newTab: \u003cbool\u003e\n      links:               # Nested links\n        - ...\n\n  groups:                  # Array of groups\n    - caption: \u003cstring\u003e\n      links:\n        - ...\n      sections:            # Array of sections within a group\n        - caption: \u003cstring\u003e\n          links:\n            - ...\n  footer:\n    links:\n      - caption: \u003cstring\u003e\n        url: \u003cstring\u003e\n        icon: \u003cstring\u003e\n        newTab: \u003cbool\u003e\n      - ...\n```\n\n## Development\n\n### Prerequisites\n\n- [Go](https://golang.org/doc/install)\n- [Task](https://taskfile.dev/#/installation)\n\n### Run Locally\n\n```bash\ntask run\n```\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n## License\n\nHuB is licensed under the [MIT](./LICENSE) license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzcubbs%2Fhub","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzcubbs%2Fhub","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzcubbs%2Fhub/lists"}