Skip to content

Commit

Permalink
docs: update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Björn Urban committed May 2, 2024
1 parent 07578e1 commit 1977749
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ 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](frontend/public/Kubevoyage.png) <!-- If you have a logo, replace 'path_to_logo.png' with its path -->
![KubeVoyage Logo](frontend/public/Kubevoyage.png)

## Features

Expand All @@ -22,12 +22,19 @@ Embarking on a secure journey in Kubernetes.
- Kubernetes cluster (for deployment)
- Helm (for deployment)

### Usage
add annotation `` to your ingress

or for easier usage you can add the annotation `kubevoyage-auth=true` to your ingress if you use the accompanying
[kubernetes operator](https://github.com/B-urb/kubevoyage-operator). The operator automatically generates the necessary middleware
and ingress annotation.

### Installation

1. **Clone the Repository**:

```bash
git clone https://github.com/yourusername/kubevoyage.git
git clone https://github.com/B-urb/kubevoyage.git
cd kubevoyage
```

Expand Down Expand Up @@ -78,6 +85,7 @@ helm repo add github-burban https://B-urb.github.io/KubeVoyage/
helm install kubevoyage github-burban/kubevoyage
```


## Testing

To run tests for the backend:
Expand Down

0 comments on commit 1977749

Please sign in to comment.