You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+47-6Lines changed: 47 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,8 +18,9 @@
18
18
-[🛠 Tech Stack](#-tech-stack)
19
19
2.[🚀 Quick Start](#-quick-start)
20
20
-[1. Clone, Install & Run](#1-clone-install--run)
21
-
-[2. 🚀 Deploy on Railway](#2--deploy-on-railway)
22
-
-[3. 🚀 Other alternatives to deploy it](#3--other-alteratives-to-deploy-it)
21
+
-[2. 🚀 Deploy with Docker](#2--deploy-with-docker)
22
+
-[3. 🚀 Deploy on Railway](#2--deploy-on-railway)
23
+
-[4. 🚀 Other alternatives to deploy it](#3--other-alteratives-to-deploy-it)
23
24
3.[📝 Changelog](#-changelog)
24
25
4.[📌 To-Do / Next Steps](#-to-do--next-steps)
25
26
5.[👨💻 Developed With](#-developed-with)
@@ -93,10 +94,50 @@ Credentials:
93
94
npm run start
94
95
```
95
96
96
-
<p> Public → http://localhost:3001
97
-
<p> Admin → http://localhost:3001/admin
97
+
> Public → http://localhost:3001
98
98
99
-
### 2. 🚀 Deploy on Railway
99
+
> Admin → http://localhost:3001/admin
100
+
101
+
### 2. 🚀 Deploy with Docker
102
+
103
+
You can run **Lynx** directly using the pre-built image from [Docker Hub](https://hub.docker.com/r/paueron/lynx).
104
+
105
+
1. Pull the image
106
+
```bash
107
+
docker pull paueron/lynx:latest
108
+
```
109
+
2. Start the container
110
+
```bash
111
+
docker run -d --name lynx \
112
+
-p 8080:8080 \
113
+
-e NODE_ENV=production \
114
+
-e PORT=8080 \
115
+
paueron/lynx:latest
116
+
```
117
+
Once started, the app will be available at:
118
+
> 👉 http://localhost:8080
119
+
120
+
> 👉 http://localhost:8080/admin
121
+
122
+
3. Optional environment variables
123
+
- JWT_SECRET – secret key used to sign JWT tokens. If not set, a random key will be generated at runtime (⚠️ highly recommended to set this in production).
124
+
125
+
- PORT – the internal server port (default: 8080).
0 commit comments