Skip to content

Commit f1bf612

Browse files
committed
address Luigi's comments, add extractors docker instructions
1 parent d57e183 commit f1bf612

File tree

2 files changed

+67
-39
lines changed

2 files changed

+67
-39
lines changed
21.6 KB
Loading

doc/src/sphinx/userguide/installing_clowder.rst

Lines changed: 67 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -25,27 +25,24 @@ For **developers of Clowder**, a hybrid is recommended. :ref:`Dev quickstart her
2525

2626
For **production instances of Clowder**, a Kubernetes deployment is recommended and manual installations are being phased out.
2727

28-
- See `Kubernetes install instructions here <https://opensource.ncsa.illinois.edu/confluence/display/CATS/Kubernetes>`__
28+
- See `Clowder's Kubernetes install instructions here <https://github.com/clowder-framework/clowder-helm>`__.
2929
- Otherwise, manually install Clowder, and each of it's required services (at a minimum: MongoDB,
30-
ElasticSearch, RabbitMQ). See
31-
`Requirements <https://clowder-framework.readthedocs.io/en/latest/admin/installing.html#requirements>`__
32-
for details.
30+
ElasticSearch, RabbitMQ). See :ref:`requirements below<requirements>` for details.
3331

3432
.. _usersOfClowder:
3533

3634
Users of Clowder: Getting Started via Docker
3735
==============================================
3836

39-
1. Install `Docker <http://docker.com/>`__ (if you haven’t already)
40-
2. Download and unzip the `latest stable version here <Download and unzip a specific version: Latest stable version.>`_
41-
3. Navigate to Clowder’s root directory in your bash command line (``cd clowder-<version_number>``)
42-
4. Download the docker script to Clowder's root directory
37+
1. Install `Docker Desktop <http://docker.com/>`__ (if you haven’t already)
38+
2. Clone or download `Clowder on Github <https://github.com/clowder-framework/clowder>`_ (use the default ``develop`` branch)
4339

4440
.. code:: bash
4541
46-
wget -O docker-compose.yml https://opensource.ncsa.illinois.edu/bitbucket/projects/CATS/repos/clowder/raw/docker-compose.yml\?at\=refs%2Fheads%2Fdevelop
42+
git clone https://github.com/clowder-framework/clowder.git
4743
48-
5. Start clowder on your local machine's command line (bash)
44+
3. Navigate to Clowder’s root directory in your bash command line (``cd clowder``)
45+
4. Start Clowder using the Docker Compose configuration, via your command line
4946

5047
.. code:: bash
5148
@@ -80,12 +77,13 @@ Easy new user creation via Docker
8077

8178
Run the (edited) command below from the base Clowder directory.
8279

83-
First, edit these properties to your liking:
80+
First, edit these properties to your liking in the ``docker run`` command below:
8481

85-
- FIRST_NAME
86-
- LAST_NAME
87-
- EMAIL_ADDRESS
88-
- PASSWORD
82+
- FIRST_NAME (default: ``Admin``)
83+
- LAST_NAME (``User``)
84+
- EMAIL_ADDRESS (``[email protected]``)
85+
- PASSWORD (``catsarecute``)
86+
- ADMIN (``true``)
8987

9088
.. code:: bash
9189
@@ -106,9 +104,7 @@ Done! You should be able to login to your new account, create new Spaces & Datas
106104
- `Check out How to Create a New Extractor <https://www.youtube.com/watch?v=0uthTzrZCt8&list=PLVhslX3lYajMZD9KA-RJK-ulmXys8d13i&index=17&ab_channel=ClowderFramework>`__
107105
- and 28 total videos covering specific Clowder topics and uses!
108106

109-
Or, try the `core data extractors <https://github.com/clowder-framework/extractors-core>`__ that most people would like to install.
110-
111-
107+
Try the :ref:`default extractors<defaultExtractors>` for simple quality of life improvements in Clowder.
112108

113109
.. _clowderDevelopers:
114110

@@ -153,9 +149,9 @@ for details.), we must tell Clowder which ports the services are using.
153149
touch docker-compose.override.yml
154150
155151
2. Copy and paste the lines below into that file we just created
156-
(``docker-compose.override.yml``)
152+
``docker-compose.override.yml``
157153

158-
.. code:: bash
154+
.. code:: yml
159155
160156
# this lets Clowder communicate with the necessary services
161157
# These services (Mongo, RabbitMQ, ElsticSearch) will be run
@@ -211,34 +207,36 @@ Part 2: Run Clowder via IntelliJ
211207

212208
- This should prompt you to install the Scala plugin! Install it.
213209

214-
3. Install the Scala Plugin for IntelliJ
210+
3. Install the Scala Plugin for IntelliJ ``File`` --> ``Settings`` --> ``Plugins`` --> ``Download Scala``.
215211
4. Install Java 8 on your computer (version 8 required, not compatible
216212
with other versions)
217213

218-
- From here: https://adoptopenjdk.net/. Java 8, HotSpot.
214+
- I find this easiest to do via IntelliJ’s Plugin Manager. ``File`` --> ``Project Structure`` --> ``SDKs`` --> ``+`` icon --> ``Download JDK``
215+
- Select ``Version 1.8`` (Clowder is only compatible with Java 8 (1.8), nothing higher) --> Vendor: ``Eclipse Temurin (AdoptOpenJDK Hotspot)`` --> ``Download``.
219216

220-
5. Connect IntelliJ to that Java instance.
217+
- Alternatively, download the JDK online at `AdoptOpenJDK <https://adoptopenjdk.net/>`__. Java 8, HotSpot.
218+
- Then point IntelliJ to the JDK folder under ``Project Structure`` --> ``SDKs`` and specify the root folder of the JDK you just downloaded.
221219

222-
- In IntelliJ: ``file`` → ``Project Structure`` → ``SDKs``
223-
- Add a new SDK, and specify the root folder of the SDK you just downloaded. For example: JDK Home path on Windows might look like ``C:\Program Files\Eclipse Foundation\jdk-8.0.302.8-hotspot``
220+
.. figure:: ../_static/IntelliJ_JDK_Download.png
221+
:alt: Download JDK from IntelliJ.
224222

225-
6. Add a new Run Configuration
223+
5. Add a new Run Configuration
226224

227225
- In the top right, click the dropdown and click “Edit Configurations…”
228226

229227
.. figure:: ../_static/GettingStarted_addConfig.png
230228
:alt: Add new configuration
231229

232-
7. Create a new ``Play 2 App`` configuration
230+
6. Create a new ``Play 2 App`` configuration
233231

234232
.. note::
235233

236-
If you **don’t see Play 2 App in the list**, you may need to use IntelliJ *Ultimate* version (instead of Community). I experienced this bug, feel free to ask in the `Clowder Slack here <https://join.slack.com/t/clowder-software/shared_invite/enQtMzQzOTg0Nzk3OTUzLTYwZDlkZDI0NGI4YmI0ZjE5MTZiYmZhZTIyNWE1YzM0NWMwMzIxODNhZTA1Y2E3MTQzOTg1YThiNzkwOWQwYWE>`_.
234+
If you **don’t see Play 2 App in the list**, ensure you have the Scala plugin installed. If Play2 still isn't there, you may need to use IntelliJ *Ultimate* version (instead of Community). I experienced this bug, feel free to ask in the `Clowder Slack here <https://join.slack.com/t/clowder-software/shared_invite/enQtMzQzOTg0Nzk3OTUzLTYwZDlkZDI0NGI4YmI0ZjE5MTZiYmZhZTIyNWE1YzM0NWMwMzIxODNhZTA1Y2E3MTQzOTg1YThiNzkwOWQwYWE>`_.
237235

238236
.. figure:: ../_static/GettingStarted_Play2Config.png
239237
:alt: Create play2 configuration.
240238

241-
8. The default configuration should be okay, see image below.
239+
7. The default configuration should be okay, see image below.
242240

243241
.. note::
244242

@@ -353,10 +351,10 @@ Method 3: Edit permissions in MongoDB
353351
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
354352

355353
To edit the permissions on *existing accounts*, **edit their properties
356-
in MongoDB**. You can skip this step if haven’t created a local Clowder
354+
in MongoDB**. You can skip this step if you haven’t created a local Clowder
357355
account yet.
358356

359-
1. Download RoboMongo (a GUI for MongoDB)
357+
1. Download a GUI for MongoDB: MongoDB Compass or a 3rd party tool like RoboMongo.
360358
2. Ensure all services are running!
361359

362360
.. code:: bash
@@ -366,20 +364,20 @@ account yet.
366364
# start all required services
367365
docker-compose up -d
368366
369-
1. Connect RoboMongo to the docker instance (the defaults should be
367+
3. Connect RoboMongo to the docker instance (the defaults should be
370368
fine)
371369

372370
1. Point it towards port ``27017``
373371

374-
2. In the file tree on the left, navigate to clowder → Collections →
372+
4. In the file tree on the left, navigate to clowder → Collections →
375373
social.users
376374

377375
1. Then click the dropdown to expand that user
378376
2. Find ``status`` field, and right click to edit.
379377
3. If it is ``Inactive``, change it by typing ``Active``
380378
(capitalized)
381379

382-
3. Done. Refresh your browser (on ``localhost:9000``) to access Clowder.
380+
5. Done. Refresh your browser (on ``localhost:9000``) to access Clowder.
383381

384382
Create a local Clowder account
385383
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -425,10 +423,41 @@ Clowder!
425423
If Clowder feels slow, add the faster JVM option
426424
------------------------------------------------
427425

428-
`Instructions are
429-
here <https://opensource.ncsa.illinois.edu/confluence/display/CATS/JVM+Configuration+Options>`__.
426+
- Follow the `instructions here to add JNotify <https://opensource.ncsa.illinois.edu/confluence/display/CATS/JVM+Configuration+Options>`__.
427+
- Simply download JNotify and tell IntelliJ where it is in the ``Run Configurations`` -> ``JVM Options``.
428+
429+
.. _defaultExtractors:
430+
Use the default extractors
431+
============================
432+
433+
434+
The default extractors offer simple quality of life improvements like image/video/pdf previews while browsing Clowder.
435+
436+
Enable them by starting Clowder with the Extractors yml file:
437+
438+
.. code:: bash
439+
440+
docker-compose -f docker-compose.yml -f docker-compose.override.yml -f docker-compose.extractors.yml up -d
441+
442+
Troubleshooting extractors
443+
---------------------------
444+
Networking issues: Error "connection refused."
445+
This is caused by the docker containers not being able to connect to each other.
446+
447+
1. In ``conf/application.conf`` edit the rabbitmq (message queue) URL to: ``clowder.rabbitmq.clowderurl="http://host.docker.internal:9000"``
448+
449+
Then restart Clowder in IntelliJ and via Docker, and everything should work. Done!
450+
451+
On Windows, I've had trouble getting ``localhost`` to resolve to the docker host. You could try the following:
452+
453+
- Access Clowder **NOT** via localhost, but via your local IP address. For example, ``55.251.130.193:9000``.
454+
455+
- You can find your local IP address:
456+
- Windows: ``Settings`` -> ``Network & internet`` -> ``IPv4 address``.
457+
- Mac: ``System Preferences`` --> ``Netowrk``--> ``Advanced``--> ``TCP/IP``--> ``IPv4 Address``. (Note: don't use the 'Public IP' from iStat Menus).
458+
- Linux ``$ ifconfig``
430459

431-
- Simply download JNotify and tell IntelliJ where it is.
460+
That should resolve extractor issues.
432461

433462
Next Steps
434463
==========
@@ -445,8 +474,7 @@ Youtube <https://www.youtube.com/playlist?list=PLVhslX3lYajMZD9KA-RJK-ulmXys8d13
445474
Extractor <https://www.youtube.com/watch?v=0uthTzrZCt8&list=PLVhslX3lYajMZD9KA-RJK-ulmXys8d13i&index=17&ab_channel=ClowderFramework>`__
446475
and many more!
447476

448-
Try the `core data
449-
extractors <https://github.com/clowder-framework/extractors-core>`__.
477+
Try the :ref:`default extractors<defaultExtractors>` for simple quality of life improvements in Clowder.
450478

451479
Resources for Developers
452480
========================

0 commit comments

Comments
 (0)