# Technical Documentation: kubero-dev/kubero > ℹ️ **Provenance:** Multi-Tier Ingestion · [CodeWiki Reference](https://codewiki.google/github.com/kubero-dev/kubero) ### Overview (`README.md`) --- [](https://github.com/kubero-dev/kubero/blob/main/LICENSE) [](https://github.com/kubero-dev/kubero/releases/latest) [](https://discord.gg/tafRPMWS4r) [](https://github.com/kubero-dev/kubero/releases/latest) [](https://demo.kubero.dev) [中文翻译](README.zh-CN.md) [日本語訳](README.ja.md) Kubero [pronounced: Kube Hero] is a self-hosted PaaS (Platform as a Service) that allows any developer to deploy their application on Kubernetes without specialized knowledge. Kubero follows the principles of 12-factor apps. It is possible to run apps based on existing containers or from source code.

More [Screenshots](https://www.kubero.dev/docs/screenshots) and a full video on [YouTube](https://www.youtube.com/watch?v=kmqhddc6UlI) ## Features ([DEMO](https://demo.kubero.dev)) - **Docker Deployments**
Deploy Docker containers on Kubernetes without needing Helm charts. - **App Templates (+160)**
Deploy popular applications like WordPress and Grafana with ready-to-use [templates](https://www.kubero.dev/templates/). - **CI/CD Pipelines**
Create unlimited pipelines with up to 4 separate staging environments for all your applications. - **GitOps Review Apps**
Automatically build, start, and clean up review apps when opening or closing pull requests. - **Automatic Redeployments**
Trigger app redeployments on pushes to branches or tags. - **Add-ons Integration**
Seamlessly deploy add-ons such as PostgreSQL and Redis alongside your applications. - **API & CLI**
Integrate seamlessly with existing tools and CI/CD workflows. - **Metrics & Monitoring**
Access integrated metrics to monitor application health. - **Notifications**
Get build and deployment updates via Discord, Slack, or Webhooks. - **Vulnerability Scans**
Perform scheduled or triggered scans for running applications. - **Application Logs**
View logs directly from the web UI for easy monitoring. - **Safe Restarts**
Restart applications safely and easily through the web UI. - **Web Console**
Use the built-in container web console for direct access. - **Scheduled Tasks**
Easily create and manage cronjobs. - **Multi-Tenancy**
Support for managing multiple tenants. - **Single Sign-On (SSO)**
Authenticate securely with GitHub and OAuth2. - **Basic Auth**
Configure Basic Auth for your applications with ease. ## Basic Concept Kubero is Kubernetes native and runs with two containers on any Kubernetes instance (kubero-ui and Operator). All data is stored on your Kubernetes etcd without an extra database. ## Add-ons | | Addon | Maintainer | Built in* | |-------------------------------------------------------------------------------------------------------------------|---------------------------|---------------------------------------------------------------------------------------|-----------| |

| Minio | [Minio](https://artifacthub.io/packages/olm/community-operators/minio-operator) | | |

| Percona MongoDB Cluster | [Percona](https://artifacthub.io/packages/olm/community-operators/mongodb-operator) | | |

| Crunchy Postgres Cluster | [Crunchy Data](https://artifacthub.io/packages/olm/community-operators/postgresql) | | |

| Redis Cluster | [Opstree](https://artifacthub.io/packages/olm/community-operators/redis-operator) | | |

| CockroachDB | [CockroachDB](https://artifacthub.io/packages/olm/community-operators/cockroachdb) | | |

| Clickhouse | [Altinity ](https://artifacthub.io/packages/olm/community-operators/clickhouse) | | \* These add-ons are shipped with the Kubero Operator. They are not High Availability (HA) ready but greate to to get you started as fast as possible. \*\* All Bitnami add-ons are deprecated and will be removed in future releases due to Broadcom's image repository removal. [read more here](https://github.com/bitnami/charts/issues/35164) ## 164+ Application templates (similar to Heroku Buttons) - WordPress - Grafana - Bitwarden - [Kuma](https://uptime.kuma.pet) - [Trilium Notes](https://github.com/zadam/trilium) - ... Check out the full [list here](https://www.kubero.dev/templates/) or submit your own app! [Read here](https://github.com/kubero-dev/kubero/blob/main/services/) how to do it. ## Quickstart **1) Download and unpack the Kubero CLI** (MacOS, Linux, Windows)

Binaries (MacOS, Linux) ```bash $ curl -fsSL get.kubero.dev | bash ``` Brew (MacOS, Linux) ```bash $ brew tap kubero-dev/kubero $ brew install kubero-cli ``` **2) Run `kubero install` to install all components on a new or your existing cluster** You can bring your own existing cluster or create one with the kubero install on one of the following providers: - GKE - Scaleway - DigitalOcean - Linode - Kind (local) ## Supported GIT repositories (hosted and self-hosted) - Gitea / Forgejo - Gogs - Github - Gitlab - Bitbucket ## Tested languages/frameworks Basically *everything* that can be packaged in a single container can be deployed by Kubero. - GoLang (including Hugo, gin-gonic) - Python (including Flask) - JavaScript/NodeJS - PHP (including Laravel) - Ruby (including Rails) - Static HTML - Rust (including Rocket) - ... ## How GitOps Works 1. Create a pipeline with the phases you need (review, test, stage, production) 2. (optional) Connect the pipeline to your git repository (GitHub, Bitbucket, GiLab, Gitea, Gogs) 3. Configure your apps with cronjobs and addons Kubero starts now building your app. Once the build is complete, Kubero will launch the final container and make it accessible via the configured domain. ## Techstack - Backend - [NestJS](https://nestjs.com/) - [TypeScript](https://www.typescriptlang.org/) - [Jest](https://jestjs.io/) - Frontend - [Vue.js](https://vuejs.org/) - [Vuetify](https://vuetifyjs.com/en/) - CLI - [Go](https://golang.org/) - [Cobra](https://cobra.dev/) - Operator - [Operator SDK](https://sdk.operatorframework.io/) - [Helm](https://helm.sh/) - Infrastructure - [Kubernetes](https://kubernetes.io/) - [Kind (Development)](https://kind.sigs.k8s.io/) ## Links - Documentation https://www.kubero.dev/docs/ - Roadmap https://github.com/orgs/kubero-dev/projects/1/views/3 ## Community [](https://discord.gg/tafRPMWS4r) ## Contributing All contributions are welcome! - Rise an issue/bug/error - Open a feature request - Discuss ideas in the discussions section or discord - Fix typos (I do a lot of them) - Contribute code - Write articles ## Supporting this project Starring this project is a huge motivation. ⭐ Thank you! [](https://starchart.cc/kubero-dev/kubero) --- ### Overview (`client/README.md`) # base ## Project setup ``` # yarn yarn # npm npm install # pnpm pnpm install # bun bun install ``` ### Compiles and hot-reloads for development ``` # yarn yarn dev # npm npm run dev # pnpm pnpm dev # bun pnpm run dev ``` ### Compiles and minifies for production ``` # yarn yarn build # npm npm run build # pnpm pnpm build # bun pnpm run build ``` ### Lints and fixes files ``` # yarn yarn lint # npm npm run lint # pnpm pnpm lint # bun pnpm run lint ``` ### Customize configuration See [Configuration Reference](https://vitejs.dev/config/). --- ### Overview (`server/README.md`) ## Description This is Kubero server part of the Kubero project. It is a NestJS application that provides REST API for the Kubero project. It is a part of the Kubero project that is a platform for managing Kubernetes clusters. ## Project setup ```bash $ yarn install ``` ## Compile and run the project ```bash # development $ yarn run start # watch mode $ yarn run start:dev # production mode $ yarn run start:prod ``` ## Administration Commands ```bash # Reset admin account (creates or updates with new password) $ yarn cli:reset-admin ``` ## Run tests ```bash # unit tests $ yarn run test # e2e tests $ yarn run test:e2e # test coverage $ yarn run test:cov ``` ## Resources Check out a few resources that may come in handy when working with NestJS: - Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework. - For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy). - To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/). - Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks. - Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com). - Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com). - To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs). - Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com). --- ### Overview (`services/README.md`) # Kubero Services Services can be added to Kubero by creating a pull request to this repository. Required qualifications to submit a service: - Single app container (not counting addons) - Publicly accessible Docker images - Maintained and documented (1 commit within the last 6 months) - Icon/Logo (square, max 300x300px) ## How to add a new services 1) Fork this repository 2) Create a new folder with the name of your service 3) Add a app.yaml and service.yaml 4) Create a pull request ### app.yaml The app yaml that describes your service technically. You can use the following template to get started. If you have a running instace of Kubero you can use the CLI to lookup the values for your service. ``` /* Detailed source-code truncated for AI context efficiency. */ ``` --- --- METRICS --- - Files Extracted: 4 - Estimated Token Budget: ~4177 tokens - Canonical Reference: https://codewiki.google/github.com/kubero-dev/kubero