Skip to content

Commit f49e42d

Browse files
committed
mention that the repository is a template repository
1 parent 3dd18b8 commit f49e42d

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22

33
## Overview
44

5-
This repository contains instructions and configuration for running your own unison.cloud "Bring Your Own Cloud" (BYOC) cluster. There are multiple options based on how you'd like to deploy your cluster:
5+
This repository contains instructions and configuration for running your own unison.cloud "Bring Your Own Cloud" (BYOC) cluster. It is a [repository template](https://gitprotect.io/blog/how-to-use-github-repository-templates/) that you are intended to create a new repository from. There are multiple options based on how you'd like to deploy your cluster:
66

77
- [Docker Compose instructions](docker/README.md) for a simple deployment on a local cluster.
88
- [EC2 instructions](ec2/README.md) to use Terraform (or OpenTofu) to deploy to to AWS EC2 instances
99
- [EKS instructions](eks/README.md) to use Terraform (or OpenTofu) to deploy on a Kubernetes cluster via AWS Elastic Kubernetes Service (EKS) and deploy Unison Cloud on the resulting Kubernetes cluster.
1010

1111

12+
1213
## Scope
1314

1415
These configurations are intended to demonstrate minimalist deployments of unison.cloud. They are **not production-ready** but serve testing, development, and demonstration purposes. They provide an easy way to test unison.cloud in your own environment, with the expectation that you might later integrate these learnings into an existing production environment.

0 commit comments

Comments
 (0)