Skip to content

Commit 5aff1fc

Browse files
committed
updated docker-compose up instructions to reflect best practices
1 parent 6958581 commit 5aff1fc

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

doc/src/sphinx/userguide/installing_clowder.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -181,12 +181,16 @@ for details.), we must tell Clowder which ports the services are using.
181181

182182
.. code:: bash
183183
184-
# make sure to pass the override file!
185-
docker-compose -f docker-compose.override.yml up -d
184+
docker-compose up -d
185+
186+
187+
.. note::
188+
By default, running ``docker-compose up -d`` uses the ``docker-compose.yml`` configuration and will apply overrides found in ``docker-compose.override.yml``. Neither file need to be specified on the command line.
189+
186190

187191
4. Go to each Mongo and ElasticSearch to see it running
188192

189-
.. code:: bash
193+
.. code:: text
190194
191195
If you get a response, it's working!
192196
@@ -251,17 +255,17 @@ previous step.
251255
- You can check by running ``docker ps`` and check that 3 services
252256
are running.
253257
- If not, start them with
254-
``docker-compose -f docker-compose.override.yml up -d``
258+
``docker-compose up -d``
255259

256260
Now in IntelliJ, click the green play button (top right) to build Clowder from source! Give it a minute to finish. Access Clowder via ``localhost:9000`` in the browser.
257261

258262
Also note, a handy debugging mode is enabled by default. You can run the debug mode by clicking the green "bug" button right beside the play button.
259263

260264
.. note::
261265

262-
Use ``localhost:9000`` when building from source (clicking the green play button in IntelliJ) and running the services via ``docker-compose -f docker-compose.override.yml up -d``
266+
Use ``localhost:9000`` when building from source (clicking the green play button in IntelliJ).``
263267

264-
Use ``localhost:8000`` when running from Docker only (without building from source) via ``docker-compose up -d``
268+
Use ``localhost:8000`` when running from Docker only (without building from source via ``docker-compose up -d``)
265269

266270
.. _creatingLocalAccount
267271
Creating a local Clowder account
@@ -383,7 +387,7 @@ Create a local Clowder account
383387
Start Clowder:
384388

385389
1. Start required services (via
386-
``docker-compose -f docker-compose.override.yml up -d`` from the root
390+
``docker-compose up -d`` from the root
387391
Clowder directory).
388392

389393
1. You can check if your services are already running using

0 commit comments

Comments
 (0)