Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Assuming you already have Installation taken care of.

Components are created in the Dashboard, using the the [+COMPONENT] button.

Expand
titleSTEP 1: Go to the dashboard and click +Component
image-20231117-212034.pngImage Modified
Image Removed
Expand
titleSTEP 2: Select a component, name it and describe it
Image Removed

Expand
titleAnd the card opens showing your component

You can click on Learn More in the component description to access its documentation. All of the iNTERFACEWARE Collections components are documented for your reference.

Image Added
  1. Select a component

  2. Add a Name, Description and Tags for your component

  3. Select optional configurations

    • Connect components - Have Iguana automatically connect the selected components in the order in which they were selected.

    • Create components as a Plain Folder - Components can either be connected to a unique git repository or treated as a plain folder where commits are stored in a single Git instance repository. See How Components are Stored in Git for choosing the configuration for your component.

  4. Click Add to import the component

Info

Notice you can also filter the components displayed by Collection - use the All Collections dropdown to select the Collection you want to display.

Image RemovedHashtags in the description like #autostart are
Expand
titleName STEP 3: Click on the component and use #hashtags like #autostart in it's description
to open its component card - note the Name, Description and Tags

Tags are used to categorize and add functionality to components. For example, #autostart is used by IguanaX to determine if components should be automatically started when the IguanaX server starts up.

Image Added

See Autostarting Components Component Cards for more information.

Expand
titleSTEP 4: Configure the custom fields on the component

Many components have custom fields Custom Fields which you can edit and set with by clicking the ellipsis on beside each one. The idea is that many components need to be configured for the environment they are in without the need to fully Customize Edit a componentComponent.

Image RemovedImage Added
Expand
titleSTEP 5: Stop and start the component using the switch button in the top left corner of the card

You can start and stop components using the switch button in the top left corner:

Image Removed

You can also do it from the list of components on the left of the dashboard and using bulk operations Bulk Actions in the dashboard.

Image Added
Expand
titleSTEP 6: Link the components together

When one component feeds into another component, it’s linked by a queue where data is securely stored on disc and fed into the next component. To link components:

Image Removed

Then in the edit connections mode we can connect the components by clicking on the first component then the second:

connect.mp4

Click Edit Connections and follow the steps here: Edit Connections.

Image Added

That shows the core operation of IguanaX. The real power comes from being able to Customize Edit a componentComponent.