...The beginning of a pleasant experience

Hajimari is a simplistically beautiful startpage designed to be the entrypoint for your self-hosted Kubernetes cluster.

• Web and app search with customizable search providers
• Dynamically list apps discovered from Kubernetes Ingresses or Custom Resources
• Display replica status for ingress endpoints
• Support for non-Kubernetes apps via custom apps config
• Customizable list of bookmarks
• Selectable themes and custom theme support
• Automatic light/dark mode
• Custom configuration overrides per user/browser
• Multiple instance support

helm repo add hajimari https://hajimari.io

helm repo update

helm install hajimari hajimari/hajimari

Helm docs

Clone the repo and run the following command to generate the hajimari binary:

make deps
make build

Or for local development with hot reload:

make deps
make dev

You will need to have go 1.19 and node 18 installed.

Hajimari will need access to a kubeconfig file for a service account with access to ingress and endpoint slice objects.

Hajimari looks for specific annotations on Ingresses.

• Add the following annotations to your ingresses in order for it to be discovered by Hajimari:

Hajimari supports the following configuration options that can be modified by either ConfigMap or values.yaml if you are using Helm

It also possible to define Apps via Kubernetes Custom Resources for those using Istio's Virtual Services, Traefik's IngressRoutes or other solutions, which does not reply on native Ingress objects:

apiVersion: hajimari.io/v1alpha1
kind: Application
metadata:
  name: hajimari-issues
spec:
  name: Hajimari Issues
  group: info
  icon: simple-icons:github
  url: https://github.com/toboshii/hajimari/issues
  info: Submit issue to this project
  targetBlank: true

It is a selector for selecting namespaces either selecting all namespaces or a list of namespaces, or filtering namespaces through labels.

Note: If you specify both labelSelector and matchNames, Hajimari will take a union of all namespaces matched and use them.

If you want to add custom themes you can provide a list of custom theme atrributes.

If you want to add custom search providers you can provide a list of custom providers to override the defaults.

searchProviders defaults to the following values:

searchProviders:
  - name: Google
    token: g
    icon: simple-icons:google
    searchUrl: https://www.google.com/search?q={query}
    url: https://www.google.com
  - name: DuckDuckGo
    token: d
    icon: simple-icons:duckduckgo
    searchUrl: https://duckduckgo.com/?q={query}
    url: https://duckduckgo.com
  - name: IMDB
    token: i
    icon: simple-icons:imdb
    searchUrl: https://www.imdb.com/find?q={query}
    url: https://www.imdb.com
  - name: Reddit
    token: r
    icon: simple-icons:reddit
    searchUrl: https://www.reddit.com/search?q={query}
    url: https://www.reddit.com
  - name: YouTube
    token: 'y'
    icon: simple-icons:youtube
    searchUrl: https://www.youtube.com/results?search_query={query}
    url: https://www.youtube.com
  - name: Spotify
    token: s
    icon: simple-icons:spotify
    searchUrl: hhttps://open.spotify.com/search/{query}
    url: https://open.spotify.com

If you want to add any apps that are not exposed through ingresses or are external to the cluster, you can use the custom apps feature. You can pass a list of custom apps inside the config.

Custom apps can be added by configuring a list of apps under an app group.

Bookmark groups can be added by creating a list of groups and associated bookmarks.

Bookmarks can be added by configuring a list of bookmarks under a group.

The search bar has a few functionalities:

• If a query starts with / (similiar to vi/vim's search) it will filter the applications in real time allowing you to quickly find the app you're looking for.
• If a query starts with @<token> and matches a token configured for a searchProvider then the request will be forwarded to the configured searchUrl with {query} replaced with the portion of the query after the token.
• If no query is provided following the token or there is no searchUrl configured for the provider, then the user will be redirected to the contents of url. This allows you to use tokens to quickly access external sites.

Any icon field can be either an Iconify supported icon (ex: mdi:kubernetes, simple-icons:google) or a URL to an image.

1. Open Hajimari in your browser, click the hamburger menu in the lower lefthand corner.
2. Modify the options you wish to change in the built-in YAML editor.
3. Click Save and you'll be redirected to your new custom page with a random ID on the URL. Set this page as your homepage/new tab page. For the best experience in Firefox I recommend the New Tab Override extension; for Chrome Custom New Tab URL.
4. You can make further modifications to this page at anytime under the hamburger menu.

Please note there is no authentication. You might want to run this behind ingress with access restrictions.

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

Please make sure to update tests as appropriate.

Run make help for information on linting, tests, etc.

Hajimari (始まり) is Japanese for beginnings. Hajimari's original intended purpose is to be used as a browser startpage, so the name seemed fitting as it's the beginning of all new tabs/windows :)

• SUI For the great startpage template
• Forecastle Ideas for integrating k8s ingress

Apache-2.0