Hajimari

Hajimari is a startpage designed as an entrypoint for self-hosted Kubernetes clusters. It dynamically discovers applications and provides a centralized dashboard.

Key Features:

• App Discovery: Dynamically lists apps discovered from Kubernetes Ingresses or Custom Resources. It also displays replica status for ingress endpoints.
• Search: Web and app search with customizable search providers.
• Extensibility: Supports non-Kubernetes apps via custom apps configuration.
• Customization: Customizable bookmarks, selectable themes (including custom theme support), and automatic light/dark mode.
• User Experience: Custom configuration overrides per user/browser and support for multiple instances.

The Hajimari search bar supports three distinct modes of operation:

1. Real-time Filtering: Start a query with / to filter the list of displayed applications.
2. Search Provider Tokens: Start a query with @<token> (e.g., @g query) to trigger a configured search provider. The {query} placeholder in the provider's searchUrl is replaced by the text following the token.
3. Direct Navigation: If a token is entered without a query, or if no searchUrl is configured, the user is redirected to the provider's url.

The namespaceSelector determines which namespaces Hajimari monitors for applications. You can select all namespaces, a specific list of names, or filter namespaces using Kubernetes label selectors. If both labelSelector and matchNames are provided, Hajimari uses the union of both.

### NamespaceSelector Fields
- `any` (bool): If `true`, all namespaces are selected.
- `labelSelector` (metav1.LabelSelector): Filter namespaces based on Kubernetes labels.
- `matchNames` ([]string): A specific list of namespace names to include.

To install Hajimari on a Kubernetes cluster, add the Hajimari Helm repository and install the chart using the following commands:

1. Add the repository: helm repo add hajimari https://hajimari.io
2. Update your repositories: helm repo update
3. Install the chart: helm install hajimari hajimari/hajimari

Detailed Helm configuration can be found in the charts/hajimari directory.

To start developing the Hajimari web UI, ensure you have installed the project dependencies using npm install, pnpm install, or yarn. You can then launch the development server using the dev script. Use the --open flag to automatically open the application in a new browser tab.

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Hajimari can automatically discover and display applications by looking for specific annotations on Kubernetes Ingress objects. To make an application visible in Hajimari, add the hajimari.io/enable annotation with the value true to your Ingress.

metadata:
  annotations:
    hajimari.io/enable: "true"
    hajimari.io/icon: "mdi:kubernetes"
    hajimari.io/appName: "My K8s Cluster"
    hajimari.io/group: "infrastructure"
    hajimari.io/info: "Access my cluster"

The Hajimari web UI is a Single Page Application (SPA) built with SvelteKit using the static adapter. To generate a production-ready version of the application, run the build script. After building, you can use the preview script to verify the production build locally.

npm run build

# To preview the production build
npm run preview

To run Hajimari locally, you must have go 1.19 and node 18 installed.

Build the binary

Clone the repository and run:

make deps
make build

Local development with hot reload

For active development with hot reloading enabled, use:

make deps
make dev

You can customize your Hajimari instance directly from the browser:

1. Open Hajimari in your browser.
2. Click the hamburger menu in the lower left-hand corner.
3. Modify settings in the built-in YAML editor.
4. Click Save. You will be redirected to a unique URL containing a random ID for your custom page.
5. Set this unique URL as your browser's homepage or new tab page.

Note: There is no built-in authentication. It is recommended to run Hajimari behind an Ingress with access restrictions.