KubeVoyage

KubeVoyage: Kubernetes Authentication Proxy

Embarking on a secure journey in Kubernetes.

KubeVoyage is a Kubernetes authentication proxy designed to streamline user access to various sites. Built with a Svelte frontend, a Go backend, and an SQL database, it offers a robust solution for managing user access in a Kubernetes environment.

KubeVoyage Logo

Features

Getting Started

Prerequisites

Installation

  1. Clone the Repository:

    git clone https://github.com/yourusername/kubevoyage.git
    cd kubevoyage
    
  2. Backend Setup:

    Navigate to the backend directory and fetch the required Go modules:

    cd backend
    go mod download
    
  3. Frontend Setup:

    Navigate to the frontend directory and install the required npm packages:

    cd frontend
    npm install
    

Running Locally

  1. Backend:

    From the backend directory:

    go run .
    
  2. Frontend:

    From the frontend directory:

    npm run dev
    

Visit http://localhost:8080 in your browser.

Deployment

Use the provided Helm chart to deploy KubeVoyage to your Kubernetes cluster:

helm install kubevoyage ./path_to_helm_chart

Testing

To run tests for the backend:

cd backend
go test ./...

Contributing

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

License

This project is licensed under the MIT License - see the LICENSE.md file for details.