openreplay/scripts/README.md
2021-05-25 19:45:07 +02:00

33 lines
1.4 KiB
Markdown

### Installing OpenReplay on any VM (Debian based, preferably Ubuntu 20.04)
You can start testing OpenReplay by installing it on any VM (at least `2 vCPUs, 8 GB of RAM and 50 GB of storage`). We'll initialize a single node kubernetes cluster with [k3s](https://k3s.io) and install OpenReplay on the cluster.
```bash
cd helm && bash install.sh
```
### Installing OpenReplay on Kubernetes
OpenReplay runs 100% on kubernetes. So if you've got a kubernetes cluster, preferably, a cluster dedicated to OpenReplay (on a single node of `4 vCPUs, 8 GB of RAM and 50 GB of storage`). You can run the script, which internally uses helm to install OpenReplay.
We hope your cluster has provision to create a [service type](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer) `LoadBalancer` for exposing OpenReplay on the internet.
```bash
cd helm && bash kube-install.sh
```
### OpenReplay CLI
The CLI is helpful for managing basic aspects of your OpenReplay instance, things such as restarting or reinstalling a service, accessing a component's logs or simply checking the status of your backend services. Below the list of covered operations:
- status: status of the running services
- logs: logs of a specific service
- stop: stop one or all services
- start: start one or all services
- restart: restart one or all services
For more information:
```bash
cd helm && openreplay-cli -h
```