Hajimari 🌅

...The beginning of a pleasant experience

Features

Web search bar
Dynamically list apps discovered from Kubernetes ingresses
Support for non-Kubernetes apps via custom apps config
Customizable list of bookmarks
Selectable themes
Custom configuration overrides per user/browser
Multiple instance support

Installation

Helm

helm repo add hajimari https://hajimari.io

helm repo update

helm install hajimari hajimari/hajimari

Helm docs

Locally

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

make build

You will need to have go installed.

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

Usage

Ingresses

Hajimari looks for specific annotations on ingresses.

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

Annotation	Description	Required
`hajimari.io/enable`	Add this with value `true` to the ingress of the app you want to show in Hajimari	`true`
`hajimari.io/icon`	Icon name from MDI icons	`false`
`hajimari.io/appName`	A custom name for your application. Use if you don't want to use the name of the ingress	`false`
`hajimari.io/group`	A custom group name. Use if you want the application to show in a different group than the namespace it is running in	`false`
`hajimari.io/instance`	A comma separated list of name/s of the Hajimari instance/s where you want this application to appear. Use when you have multiple Hajimari instances	`false`
`hajimari.io/url`	A URL for the Hajimari app (This will override the ingress URL). It MUST begin with a scheme i.e., `http://` or `https://`	`false`

Config

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

Field	Description	Default	Type
defaultEnable	Set to true to expose all ingresses in selected namespaces by default	false	bool
namespaceSelector	Namespace selector which uses a combination of hardcoded namespaces as well as label selectors	any: true	NamespaceSelector
title	Title for the Hajimari instance	"Hajimari"	string
instanceName	Name of the Hajimari instance	""	string
customApps	A list of custom apps that you would like to add to the Hajimari instance	{}	[]CustomApp
groups	A list of bookmark groups to add to the Hajimari instance	{}	[]groups

NamespaceSelector

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

Field	Description	Default	Type
any	Boolean describing whether all namespaces are selected in contrast to a list restricting them	false	bool
labelSelector	Filter namespaces based on kubernetes metav1.LabelSelector type	null	metav1.LabelSelector
matchNames	List of namespace names	null	[]string

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

Custom apps

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 an array of custom apps inside the config.

Field	Description	Type
name	Name of the custom app	String
icon	URL of the icon for the custom app	String
url	URL of the custom app	String
group	Group for the custom app	String

Bookmarks

Bookmark groups can be added by creating an array of group names and links.

Field	Description	Type
name	Name of the bookmark group	String
links	Array of links	Array

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

Field	Description	Type
name	Name of the bookmark	String
url	URL of the bookmark	String

Custom startpage setup

Open Hajimari in your browser, click the hamburger menu in the lower lefthand corner.
Modify the options you wish to change in the built-in YAML editor.
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.
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.

Contributing

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.

About

Why Hajimari?

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

Thank you / dependencies

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

License

Apache-2.0

fastlorenzo/hajimari