Skip to content

Commit 402ae1f

Browse files
author
Kastan Day
committed
editing improvements, clarify extractors getting started
1 parent d4562c8 commit 402ae1f

File tree

1 file changed

+32
-24
lines changed

1 file changed

+32
-24
lines changed

doc/src/sphinx/userguide/installing_clowder.rst

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ Part 1: Setup Docker
129129
git clone https://github.com/clowder-framework/clowder.git
130130
131131
3. Navigate to Clowder’s root directory (``cd clowder``)
132-
4. Expose ports for Docker services to Clowder (below)
132+
4. Expose ports for Docker services to Clowder 👇
133133

134134
Expose Docker services’ ports to Clowder
135135
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -194,7 +194,7 @@ for details.), we must tell Clowder which ports the services are using.
194194
localhost:15672 -- should see RabbitMQ login screen (no need to login tho!)
195195
localhost:9200 -- Should see a json file with "name" : "Machine Teen"
196196
197-
Done! Now keep that running, and next let’s build Clowder from source.
197+
Done! Now keep that running, and next let’s build Clowder from source 👇
198198

199199
Part 2: Run Clowder via IntelliJ
200200
--------------------------------
@@ -257,15 +257,16 @@ previous step.
257257

258258
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.
259259

260-
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.
260+
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.
261261

262262
.. note::
263263

264-
Use ``localhost:9000`` when building from source (clicking the green play button in IntelliJ).``
264+
Use ``localhost:9000`` when **building from source** (clicking the green play button ▶️ in IntelliJ).``
265265

266-
Use ``localhost:8000`` when running from Docker only (without building from source via ``docker-compose up -d``)
266+
Use ``localhost:8000`` when **running from Docker only** (via ``docker-compose up -d`` without building from source)
267267

268268
.. _creatingLocalAccount
269+
269270
Creating a local Clowder account
270271
--------------------------------
271272

@@ -302,7 +303,9 @@ First, edit these properties to your liking:
302303
303304
docker run --rm -ti --network clowder_clowder -e FIRST_NAME=Admin -e LAST_NAME=User -e [email protected] -e PASSWORD=catsarecute -e ADMIN=true clowder/mongo-init
304305
305-
Now you can login to Clowder (``localhost:9000`` or ``localhost:8000`` if not building from source Docker) in your browser
306+
✅ Configuration complete! Now you can login to Clowder via ``localhost:9000`` in your browser.
307+
308+
:ref:`Skip to using default extractors and developer resources <defaultExtractors>` 👇
306309

307310
User creation method 2 and 3
308311
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -406,7 +409,7 @@ link.
406409

407410
Look for this in the console:
408411

409-
- Don’t see it? Make sure you enabled ``smtp.mock=true`` above!!
412+
- Don’t see it? Make sure you enabled ``smtp.mock=true`` above.
410413

411414
.. code:: python
412415
@@ -427,18 +430,28 @@ If Clowder feels slow, add the faster JVM option
427430
- Simply download JNotify and tell IntelliJ where it is in the ``Run Configurations`` -> ``JVM Options``.
428431

429432
.. _defaultExtractors:
433+
430434
Use the default extractors
431435
============================
432436

433437

434-
The default extractors offer simple quality of life improvements like image/video/pdf previews while browsing Clowder.
438+
The default extractors offer simple quality of life improvements for image, video, pdf, and audio file previews while browsing Clowder.
435439

436-
Enable them by starting Clowder with the Extractors yml file:
440+
Enable them by starting Clowder with the extractors file ``docker-compose.extractors.yml``:
437441

438442
.. code:: bash
439443
440444
docker-compose -f docker-compose.yml -f docker-compose.override.yml -f docker-compose.extractors.yml up -d
441445
446+
Or run NCSA GeoServer for viewing and editing geospacial data via ``docker-compose.geoserver.yml``:
447+
448+
* geoserver
449+
* ncsa_geo_shp
450+
* extractor-geotiff-preview
451+
* extractor-geotiff-metadata
452+
453+
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>`__.
454+
442455
Troubleshooting extractors
443456
---------------------------
444457
Networking issues: Error "connection refused."
@@ -448,7 +461,7 @@ This is caused by the docker containers not being able to connect to each other.
448461

449462
Then restart Clowder in IntelliJ and via Docker, and everything should work. Done!
450463

451-
On Windows, I've had trouble getting ``localhost`` to resolve to the docker host. You could try the following:
464+
On Windows, I've had trouble getting ``localhost`` to resolve to the Docker host. You could try the following:
452465

453466
- Access Clowder **NOT** via localhost, but via your local IP address. For example, ``55.251.130.193:9000``.
454467

@@ -476,6 +489,12 @@ Youtube <https://www.youtube.com/playlist?list=PLVhslX3lYajMZD9KA-RJK-ulmXys8d13
476489

477490
Try the :ref:`default extractors<defaultExtractors>` for simple quality of life improvements in Clowder.
478491

492+
Write your own extractors using the `PyClowder Python package <https://github.com/clowder-framework/pyclowder>`__.
493+
494+
🤔❓ Please ask any questions on our `Clowder Slack <clowder-software.slack.com>`__.
495+
496+
.. _clowder-python:
497+
479498
Resources for Developers
480499
========================
481500

@@ -498,21 +517,11 @@ own <https://opensource.ncsa.illinois.edu/confluence/display/CATS/Extractors>`__
498517
files <https://github.com/clowder-framework/extractors-zip>`__
499518
- `Virus checker
500519
extractor <https://github.com/clowder-framework/extractors-clamav>`__
501-
(ensure dataset doesn’t have viruses)
502-
503-
504-
505-
506-
507-
508-
509-
510-
511-
520+
(to ensure datasets don't have viruses)
512521

513522

514523
Customize Deployment
515-
=================
524+
======================
516525

517526

518527
Customize your deployment by creating a custom folder in Clowder's root directory and add a ``/custom/custom.conf`` and a
@@ -575,9 +584,8 @@ For example the following ``play.plugins`` file will enable some additional plug
575584
576585
.. _requirements:
577586

578-
******
579587
Requirements
580-
******
588+
=============
581589

582590
Following is a list of requirements for the Clowder software. Besides Java, all other services/software
583591
can be installed on other machines with Clowder configured to communicate with them.

0 commit comments

Comments
 (0)