From 5fec6c949df5fd032b32b193123d64860403bb27 Mon Sep 17 00:00:00 2001
From: MuktadirHassan <tamimmuktadir@gmail.com>
Date: Thu, 27 Jun 2024 18:15:46 +0600
Subject: [PATCH] docs: added documentation to deploy huly using traefik

---
 traefik/README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 traefik/README.md

diff --git a/traefik/README.md b/traefik/README.md
new file mode 100644
index 0000000..5a950c7
--- /dev/null
+++ b/traefik/README.md
@@ -0,0 +1,41 @@
+# Instructions to deploy Huly on a `self-hosted` server with SSL using `Traefik`
+
+### Prerequisites
+
+- A domain name pointing to the server
+- A server with Docker and Docker Compose installed
+
+### Steps
+
+1. Clone the repository
+
+   ```bash
+   git clone https://github.com/hcengineering/huly-selfhost.git
+   cd huly-selfhost/traefik
+   ```
+
+2. Run setup.sh
+
+   ```bash
+   chmod +x setup.sh
+   ./setup.sh
+   ```
+
+3. Follow the instructions in the setup script to configure your domain name and email address
+
+   ```bash
+   $ ./setup.sh
+   Enter the domain name: example.com
+   Enter the email address: admin@example.com
+   Setup is complete. Run 'docker compose up -d' to start the services.
+   ```
+
+4. Modify the `docker-compose.yml` file to customize any settings
+
+5. Start the services
+
+   ```bash
+   docker compose up -d
+   ```
+
+6. Access Huly at `https://example.com`