Skip to content

Commit 4ed8fff

Browse files
authored
update vi-docker-tutorial.md (fixes #3384) (#3385)
1 parent f97b5e4 commit 4ed8fff

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

pages/vi/vi-docker-tutorial.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ Once confirmed, follow the directions below to spin up Planet on your OS.
4646

4747
## Linux - Run Planet Community with Docker
4848

49+
**Hint**: The code block below may seem lengthy, but once you understand it, you can copy multiple lines (or the entire block) and paste it into your terminal to run everything at once, rather than executing each line individually.
50+
4951
```bash
5052
# pull the latest tags for the planet, db-init, and chatapi Docker images
5153
docker pull treehouses/planet:latest
@@ -71,22 +73,15 @@ wget https://raw.githubusercontent.com/ole-vi/planet-prod-configs/refs/heads/mai
7173

7274
# starts the containers in the background
7375
bash planet.sh up
74-
75-
# see if the docker containers are running
76-
# ensure it says "Up" in STATUS column
77-
# with the exception of db-init, which may finished running and exited already
78-
# if chatapi service is restarting or exited, please ignore it for now as we are working on a fix
79-
docker container ls -a
80-
81-
# follow the log in action, press 'control+c' to exit the logs view
82-
docker compose -p planet logs -f
8376
```
8477

8578
## macOS/Windows - Run Planet Community with Docker
8679

8780
- **macOS**: run commands below in the terminal app of your choice.
8881
- **Windows**: run commands below in your Git Bash app.
8982

83+
**Hint**: The code block below may seem lengthy, but once you understand it, you can copy multiple lines (or the entire block) and paste it into your terminal or Git Bash to run everything at once, rather than executing each line individually.
84+
9085
<!--
9186
- **Windows with WSL**: run commands below in your Debian app.
9287
- **Windows without WSL**: run commands below in Git Bash.
@@ -116,7 +111,11 @@ curl https://gist.githubusercontent.com/xyb994/5760570db3dd4defe580e8bfff9a4bea/
116111

117112
# starts the containers in the background
118113
bash planet.sh up
114+
```
115+
116+
## Services and Ports
119117

118+
```bash
120119
# see if the docker containers are running, you may also do this in the docker desktop app
121120
# ensure it says "Up" or "Running" in the status column
122121
# with the exception of db-init, which may finished running and exited already
@@ -127,21 +126,19 @@ docker container ls -a
127126
docker compose -p planet logs -f
128127
```
129128

130-
## Services and Ports
131-
132129
The services will be accessible on the following ports:
133130

134131
- **Planet:** 3300
135132
- **ChatAPI:** 5050
136133
- **CouchDB:** 2300
137134

138-
To verify that the Planet service is running, visit [http://localhost:3300](http://localhost:3300) or [http://127.0.0.1:3300](http://127.0.0.1:3300) and check if the planet configuration screen appears. **Please do not configure the planet yet; we'll handle that in the next step.**
139-
140-
You can also verify that the other services are running by visiting these URLs in your browser:
135+
You can verify the CouchDB and ChatAPI services are running by visiting these URLs in your browser:
141136

142137
- **CouchDB:** [http://localhost:2300](http://localhost:2300)
143138
- **ChatAPI:** [http://localhost:5050](http://localhost:5050)
144139

140+
To verify that the Planet service is running, visit [http://localhost:3300](http://localhost:3300) or [http://127.0.0.1:3300](http://127.0.0.1:3300) and check if the planet configuration screen appears. **Please leave the page open and we will handle the configuration of planet in the next step.**
141+
145142
## More about Docker and Docker Compose Commands
146143

147144
Here are a few common Docker CLI commands you might need when working with `planet`:

0 commit comments

Comments
 (0)