From 5b1efcc403fcbf63a83581ad5114f910ef85fba2 Mon Sep 17 00:00:00 2001 From: 8yatharthCodes <8yatharth@gmail.com> Date: Wed, 27 May 2026 11:40:07 +0530 Subject: [PATCH] Simplifying installation --- README.md | 51 +++++++++++---------------------------- install-docker-compose.md | 8 ++++++ install-docker.md | 14 +++++++++++ install-kubernetes.md | 11 +++++++++ 4 files changed, 47 insertions(+), 37 deletions(-) create mode 100644 install-docker-compose.md create mode 100644 install-docker.md create mode 100644 install-kubernetes.md diff --git a/README.md b/README.md index 6e6a15b..a2f860f 100644 --- a/README.md +++ b/README.md @@ -113,45 +113,16 @@ --- -## Install - -Three ways to run — pick what fits your stack: - -### Docker (fastest) +## Installation ```bash docker pull ghcr.io/fluidifyai/regen:latest ``` -Need the full stack? One command: - -```bash -curl -O https://raw.githubusercontent.com/FluidifyAI/Regen/main/docker-compose.yml -docker-compose up -d -``` - -Open **http://localhost:8080** — API and UI are ready. No configuration required to start receiving alerts. - -### Docker Compose (recommended for self-hosting) - -```bash -git clone https://github.com/FluidifyAI/Regen.git -cd Regen -cp .env.example .env # edit as needed -docker-compose up -d -``` - -### Kubernetes (Helm) - -```bash -helm repo add fluidify https://charts.fluidify.ai -helm repo update -helm install fluidify-regen fluidify/fluidify-regen \ - --set ingress.host=incidents.your-domain.com \ - --set postgresql.auth.password= -``` - -For production HA (external DB, Redis Sentinel, zero-downtime deploys), see [docs/OPERATIONS.md](docs/OPERATIONS.md). +For detailed installation guides, see: +- [Docker](install-docker.md) +- [Docker Compose](install-docker-compose.md) +- [Kubernetes](install-kubernetes.md) --- @@ -220,7 +191,7 @@ Full security architecture: [SECURITY.md](SECURITY.md) ## Contributing -Issues, PRs, and feature requests are welcome. If you're coming from Grafana OnCall, your experience building on that platform is exactly what we need. +We love contributions big and small. This is how you join us: ```bash # Start backend + dependencies @@ -233,11 +204,17 @@ cd backend && go run ./cmd/regen/... serve cd frontend && npm install && npm run dev ``` -See [CONTRIBUTING.md](CONTRIBUTING.md) and [Makefile](Makefile) (`make help`) for all commands. For bigger changes, [open a discussion first](https://github.com/FluidifyAI/Regen/discussions). +Read for raising a PR: +- Read the setup & workflow in [CONTRIBUTING.md](CONTRIBUTING.md) +- Discover all developer commands with `make help` +- Have a big idea? [Let’s discuss it first](https://github.com/FluidifyAI/Regen/discussions) --- -> Missing something? [Open an issue](https://github.com/FluidifyAI/Regen/issues/new) — the generic webhook covers most tools today. +## Support us +If you find Regen useful, consider supporting us by: +- Star this repo - It helps others discover Regen +- [Guide us](https://github.com/FluidifyAI/Regen/issues/new) - Every issue you raise goes into building --- diff --git a/install-docker-compose.md b/install-docker-compose.md new file mode 100644 index 0000000..1b17d03 --- /dev/null +++ b/install-docker-compose.md @@ -0,0 +1,8 @@ +# Docker Compose (recommended for self-hosting) + +```bash +git clone https://github.com/FluidifyAI/Regen.git +cd Regen +cp .env.example .env # edit as needed +docker-compose up -d +``` \ No newline at end of file diff --git a/install-docker.md b/install-docker.md new file mode 100644 index 0000000..7e8132d --- /dev/null +++ b/install-docker.md @@ -0,0 +1,14 @@ +# Docker (fastest) + +```bash +docker pull ghcr.io/fluidifyai/regen:latest +``` + +Need the full stack? One command: + +```bash +curl -O https://raw.githubusercontent.com/FluidifyAI/Regen/main/docker-compose.yml +docker-compose up -d +``` + +Open **http://localhost:8080** — API and UI are ready. No configuration required to start receiving alerts. diff --git a/install-kubernetes.md b/install-kubernetes.md new file mode 100644 index 0000000..f3a96cf --- /dev/null +++ b/install-kubernetes.md @@ -0,0 +1,11 @@ +# Kubernetes (Helm) + +```bash +helm repo add fluidify https://charts.fluidify.ai +helm repo update +helm install fluidify-regen fluidify/fluidify-regen \ + --set ingress.host=incidents.your-domain.com \ + --set postgresql.auth.password= +``` + +For production HA (external DB, Redis Sentinel, zero-downtime deploys), see [docs/OPERATIONS.md](docs/OPERATIONS.md). \ No newline at end of file