Skip to content

Commit 44389bb

Browse files
committed
DockerHub build & readme instructions
1 parent cd9e5c0 commit 44389bb

File tree

1 file changed

+47
-6
lines changed

1 file changed

+47
-6
lines changed

README.md

Lines changed: 47 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@
1818
- [🛠 Tech Stack](#-tech-stack)
1919
2. [🚀 Quick Start](#-quick-start)
2020
- [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)
2324
3. [📝 Changelog](#-changelog)
2425
4. [📌 To-Do / Next Steps](#-to-do--next-steps)
2526
5. [👨‍💻 Developed With](#-developed-with)
@@ -93,10 +94,50 @@ Credentials:
9394
npm run start
9495
```
9596

96-
<p> Public → http://localhost:3001
97-
<p> Admin → http://localhost:3001/admin
97+
> Public → http://localhost:3001
9898
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).
126+
127+
- NODE_ENV – Node.js environment (default: production).
128+
129+
4. Data persistence (recommended)
130+
```bash
131+
docker run -d --name lynx \
132+
-p 8080:8080 \
133+
-e NODE_ENV=production \
134+
-e PORT=8080 \
135+
-e JWT_SECRET="your-very-secret-key" \
136+
-v lynx_data:/app/server \
137+
paueron/lynx:latest
138+
```
139+
140+
### 3. 🚀 Deploy on Railway
100141

101142
You can deploy **Lynx** on [Railway](https://railway.com) in a few steps:
102143
1. Go to **Railway Dashboard** → New → **GitHub Repo**
@@ -113,7 +154,7 @@ You can deploy **Lynx** on [Railway](https://railway.com) in a few steps:
113154
4. Click **Create** and wait for the deployment ✨
114155
5. Add a public domain in the settings
115156

116-
### 3. 🚀 Other alternatives to deploy it:
157+
### 4. 🚀 Other alternatives to deploy it:
117158

118159
- [Render](https://render.com/)
119160
- [DigitalOcean App Platform](https://www.digitalocean.com/products/app-platform)

0 commit comments

Comments
 (0)