https://github.com/zcubbs/hub

hub is a links & 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.
https://github.com/zcubbs/hub

bookmarks go landing-page links

Last synced: about 1 year ago
JSON representation

hub is a links & 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.

• Host: GitHub
• URL: https://github.com/zcubbs/hub
• Owner: zcubbs
• License: mit
• Created: 2022-07-15T18:03:48.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-05T14:16:55.000Z (about 2 years ago)
• Last Synced: 2025-04-11T22:12:42.930Z (about 1 year ago)
• Topics: bookmarks, go, landing-page, links
• Language: Go
• Homepage:
• Size: 311 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# hub

`hub` is a links & 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.

[![tag](https://img.shields.io/github/tag/zcubbs/hub)](https://github.com/zcubbs/hub/releases)

![Go Version](https://img.shields.io/badge/Go-%3E%3D%201.21-%23007d9c)

[![GoDoc](https://godoc.org/github.com/zcubbs/hub?status.svg)](https://pkg.go.dev/github.com/zcubbs/hub)

[![Lint](https://github.com/zcubbs/hub/actions/workflows/lint.yaml/badge.svg)](https://github.com/zcubbs/hub/actions/workflows/lint.yaml)

[![Scan](https://github.com/zcubbs/hub/actions/workflows/scan.yaml/badge.svg?branch=main)](https://github.com/zcubbs/hub/actions/workflows/scan.yaml)

![Build Status](https://github.com/zcubbs/hub/actions/workflows/test.yaml/badge.svg)

[![Go Report Card](https://goreportcard.com/badge/github.com/zcubbs/hub)](https://goreportcard.com/report/github.com/zcubbs/hub)

[![Contributors](https://img.shields.io/github/contributors/zcubbs/hub)](https://github.com/zcubbs/hub/graphs/contributors)

[![License](https://img.shields.io/github/license/zcubbs/hub.svg)](./LICENSE)

![](docs/showcase_4.png)

## Installation

> Supported Platforms: `linux_amd64/linux_arm64`.

### From Binary

You can download the latest release from [here](https://github.com/zcubbs/hub/releases)

```bash

hub -config /path/to/config.yaml

```

### Using Docker

```bash

docker run -d \

    -p 8000:8000 \

    -v /path/to/config.yaml:/app/config.yaml \

    ghcr.io/zcubbs/hub:latest

```

### Using Helm

```bash

helm install hub oci://ghcr.io/zcubbs/hub/hub -f /path/to/values.yaml

```

see [values.yaml](charts/hub/values.yaml) for the default values.

## Configuration

HuB 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:

```yaml

app:

  server:

    port:              # Application port

  customHtml:       # Custom HTML content

  title:            # Application title

  subtitle:         # Application subtitle

  logoUrl:          # URL to the logo image

  disclaimer:       # Disclaimer text

  debug:              # Debug mode (true/false)

data:

  links:                   # Array of main links

    - caption: 

      url: 

      icon: 

      newTab: 

      links:               # Nested links

        - ...

  groups:                  # Array of groups

    - caption: 

      links:

        - ...

      sections:            # Array of sections within a group

        - caption: 

          links:

            - ...

  footer:

    links:

      - caption: 

        url: 

        icon: 

        newTab: 

      - ...

```

## Development

### Prerequisites

- [Go](https://golang.org/doc/install)

- [Task](https://taskfile.dev/#/installation)

### Run Locally

```bash

task run

```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License

HuB is licensed under the [MIT](./LICENSE) license.