Skip to content

Commit 31270b1

Browse files
KastanDaylmarini
andauthored
Copy improvements to extractors troubleshooting (#315)
After setting up extractors yet again, I clarified the troubleshooting section in the docs for concision and correctness. Ex: saving the page is sufficient (in application.conf) instead of a full Clowder restart. Co-authored-by: Luigi Marini <[email protected]>
1 parent a9c2700 commit 31270b1

File tree

1 file changed

+23
-12
lines changed

1 file changed

+23
-12
lines changed

doc/src/sphinx/userguide/installing_clowder.rst

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ for details.), we must tell Clowder which ports the services are using.
198198
199199
localhost:27017 -- "It looks like you're trying to access MongoDB" Success!
200200
localhost:15672 -- should see RabbitMQ login screen (no need to login tho!)
201-
localhost:9200 -- Should see a json file with "name" : "Machine Teen"
201+
localhost:9200 -- Should see a json file with "name" : "Machine Teen" (Note this is optional! Clowder can function fine without Elasticsearch)
202202
203203
Done! Now keep that running, and next let’s build Clowder from source 👇
204204

@@ -441,12 +441,13 @@ Use the default extractors
441441
============================
442442

443443

444-
The default extractors offer simple quality of life improvements for image, video, pdf, and audio file previews while browsing Clowder.
444+
The default extractors offer simple quality of life improvements for image, video, pdf, and audio file previews while browsing Clowder. Extractors also offer powerful capabilities for manipulating your data in Clowder, see `PyClowder <https://github.com/clowder-framework/pyclowder>`__ for additional capabilities, including running machine learning training on your data stored in Clowder.
445445

446-
Enable them by starting Clowder with the extractors file ``docker-compose.extractors.yml``:
446+
Enable the default Extractors:
447447

448448
.. code:: bash
449-
449+
450+
# start Clowder with extractor support
450451
docker-compose -f docker-compose.yml -f docker-compose.override.yml -f docker-compose.extractors.yml up -d
451452
452453
Or run NCSA GeoServer for viewing and editing geospacial data via ``docker-compose.geoserver.yml``:
@@ -456,27 +457,37 @@ Or run NCSA GeoServer for viewing and editing geospacial data via ``docker-compo
456457
* extractor-geotiff-preview
457458
* extractor-geotiff-metadata
458459

460+
.. code:: bash
461+
462+
# start Clowder with default extractors, and GeoServer extractors
463+
docker-compose -f docker-compose.yml -f docker-compose.override.yml -f docker-compose.extractors.yml -f docker-compose.geoserver.yml up -d
464+
459465
Learn more about `GeoServer <https://wiki.ncsa.illinois.edu/display/NCSASoftware/GeoServer+Focus+Group+Final+Report>`__ and `read the documentation <https://wiki.ncsa.illinois.edu/display/MM/Documentation>`__.
460466

461467
Troubleshooting extractors
462468
---------------------------
463-
Networking issues: Error "connection refused."
464-
This is caused by the docker containers not being able to connect to each other.
469+
First, make sure you include the extractors when starting Docker! See ``docker-compose.extractors.yml`` in :ref:`the section above <_defaultExtractors>`.
470+
471+
If running the extractor results in a ``"Failed to establish a new connection: [Errno 111] Connection refused"``, this is a Docker networking issue. Containers must be able to talk to each other (Clowder talking to RabbitMQ).
472+
473+
To resolve, open ``clowder/conf/application.conf`` search for and set the RabbitMQ message queue URL:
474+
475+
.. code:: yml
465476
466-
1. In ``conf/application.conf`` edit the rabbitmq (message queue) URL to: ``clowder.rabbitmq.clowderurl="http://host.docker.internal:9000"``
477+
clowder.rabbitmq.clowderurl="http://host.docker.internal:9000"
467478
468-
Then restart Clowder in IntelliJ and via Docker, and everything should work. Done!
479+
Simply saving the file should fix the issue. You can again "submit a file for extraction" on the file's details page. Done!
469480

470-
On Windows, I've had trouble getting ``localhost`` to resolve to the Docker host. You could try the following:
481+
If navigating to ``localhost:9000`` yields nothing, try this. On Windows, I've had trouble getting ``localhost`` to resolve to the Docker host, so:
471482

472-
- Access Clowder **NOT** via localhost, but via your local IP address. For example, ``55.251.130.193:9000``.
483+
- Access Clowder **not** via localhost, but **via your local IP address**. For example, ``55.251.130.193:9000``.
473484

474-
- You can find your local IP address:
485+
- Find your local IP address:
475486
- Windows: ``Settings`` -> ``Network & internet`` -> ``IPv4 address``.
476487
- Mac: ``System Preferences`` --> ``Netowrk``--> ``Advanced``--> ``TCP/IP``--> ``IPv4 Address``. (Note: don't use the 'Public IP' from iStat Menus).
477488
- Linux ``$ ifconfig``
478489

479-
That should resolve extractor issues.
490+
That should resolve extractor issues across all major platforms, including Apple Silicon (M1).
480491

481492
Next Steps
482493
==========

0 commit comments

Comments
 (0)