Skip to content

Commit de29e6c

Browse files
committed
docs: update Quickstart to use pre-built Docker images, remove Discord badge
1 parent 2e74139 commit de29e6c

5 files changed

Lines changed: 28 additions & 18 deletions

File tree

Makefile

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,13 @@
22

33
.PHONY: up down restart logs build test clean
44

5-
# Default: Start the entire stack in detached mode
5+
# Default: Start the entire stack in detached mode using pre-built images
66
up:
7-
docker-compose up -d --build
7+
docker-compose up -d
88

9+
# Start the stack and build local images from source
10+
up-dev:
11+
docker-compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build
912
# Stop and remove containers
1013
down:
1114
docker-compose down

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,6 @@
1313
<a href="https://github.com/Prescott-Data/nexus-framework/discussions">
1414
<img src="https://img.shields.io/badge/GitHub-Discussions-181717.svg?logo=github" alt="GitHub Discussions">
1515
</a>
16-
<a href="#">
17-
<img src="https://img.shields.io/badge/Discord-join%20chat-7289DA.svg?logo=discord" alt="Discord">
18-
</a>
1916
<a href="https://zenodo.org/records/18315572">
2017
<img src="https://img.shields.io/badge/Paper-Zenodo-blue.svg" alt="Zenodo Paper">
2118
</a>
@@ -55,11 +52,11 @@ The fastest way to get your Nexus stack running is with Docker Compose. This spi
5552
# 1. Configure environment
5653
cp .env.example .env
5754

58-
# 2. Start the stack
59-
make up
55+
# 2. Start the stack (pulls official pre-built images)
56+
docker-compose up -d
6057

61-
# Or if you don't have make:
62-
docker-compose up -d --build
58+
# Or if you want to develop and build from source:
59+
# docker-compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build
6360
```
6461

6562
**Access Points:**

docker-compose.dev.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
version: '3.8'
2+
3+
services:
4+
broker:
5+
build:
6+
context: ./nexus-broker
7+
dockerfile: Dockerfile
8+
image: nexus-broker:dev
9+
10+
gateway:
11+
build:
12+
context: ./nexus-gateway
13+
dockerfile: Dockerfile
14+
image: nexus-gateway:dev

docker-compose.yml

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,7 @@ services:
3333

3434
# --- Applications ---
3535
broker:
36-
build:
37-
context: ./nexus-broker
38-
dockerfile: Dockerfile
36+
image: ghcr.io/prescott-data/nexus-broker:latest
3937
container_name: nexus-broker
4038
depends_on:
4139
postgres:
@@ -66,9 +64,7 @@ services:
6664
REQUIRE_ALLOWLIST: ${REQUIRE_ALLOWLIST}
6765

6866
gateway:
69-
build:
70-
context: ./nexus-gateway
71-
dockerfile: Dockerfile
67+
image: ghcr.io/prescott-data/nexus-gateway:latest
7268
container_name: nexus-gateway
7369
depends_on:
7470
- broker

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ cp .env.example .env
4040

4141
### 2. Start the Stack
4242
```bash
43-
make up
44-
# Or using docker-compose directly:
45-
# docker-compose up -d --build
43+
docker-compose up -d
44+
# Or if you want to develop and build from source:
45+
# docker-compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build
4646
```
4747

4848
### 3. Verify Access

0 commit comments

Comments
 (0)