From 19d73f9e3143304bdc48594ea85396b41419b930 Mon Sep 17 00:00:00 2001
From: Cris Mathew <crsmthw@noreply.localhost>
Date: Tue, 20 Aug 2024 08:41:22 +0300
Subject: [PATCH] Add linkwarden/README.md

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

diff --git a/linkwarden/README.md b/linkwarden/README.md
new file mode 100644
index 0000000..060e56b
--- /dev/null
+++ b/linkwarden/README.md
@@ -0,0 +1,27 @@
+# Installation
+
+## 1. Clone the Linkwarden repository
+
+```
+$ git clone https://github.com/linkwarden/linkwarden.git
+$ cd linkwarden
+```
+
+## 2. Configure the Environment Variables
+
+Inside the ```/linkwarden``` folder, copy the ```.env``` file from above and make required changes to the contents inside it with ```nano .env```
+
+Example ```.env``` contents:
+```
+NEXTAUTH_SECRET=VERY_SENSITIVE_SECRET
+NEXTAUTH_URL=https://subdomain.domain.com/api/v1/auth
+POSTGRES_PASSWORD=YOUR_POSTGRES_PASSWORD
+```
+
+## 3. Replace the compose file
+
+Delete the original compose inside the ```/linkwarden``` folder with ```rm docker-compose.yml``` and then add my compose file in its place. Make changes to the domain in traefik labels.
+
+## 4. Run
+
+Run it with ```docker compose up -d```
\ No newline at end of file