Getting Started

This guide is a quick start to MuleForge.

View Projects Currently Hosted on MuleForge

The list of active projects can be found by clicking 'PROJECTS' from the top navigation bar.

Active projects are divided into categories depending on their nature, namely Transports; Modules; Tools and Docs/Examples.

The list includes projects which currently have no owner, as well as projects which are currently being developed by an owner and possibly a team of developers.

Next to each project you can find its maturity level. Projects in their beta or production stage may be downloaded by clicking on the corresponding maturity level link, namely '4 - Beta' and '5 - Production' respectively.

Search for a Particular Project

• Click 'SEARCH' from the top navigation bar.
• Enter the name of the project. You may also make use of wildcards.
• You may also set any or none of the following fields: Project Maturity; Category; Status; and Mule Version. (The default value of these fields is set to 'Any'.)
• Press 'Enter' or hit the 'Search' button.

View the Homepage of a Project

• Search for a project.
• Click on the 'Homepage' button.

Download a MuleForge Project

MuleForge projects which are in their beta or production stage may be downloaded.

There are two easy ways of downloading a project:

• Search for a project and press the 'Download' button. OR
• Click 'PROJECTS' from the top navigation bar - this loads the list of projects currently hosted on MuleForge - and click the Maturity Level link ('4 - Beta' or '5 - Production') of the project you want to download.
  

  Only projects which are in the Beta or Production maturity level stage, i.e. for which a release has been made, can be downloaded. Read 'Project Maturity Levels' for more information.

Register for a MuleForge Account

You need to create an account on MuleForge if you want to become a Project Developer or Project Owner (also called project despot).

To create a NEW user account on MuleForge:

• Click the Signup link and enter the required information. (Enter your details in all fields, as these are required as explained below.)

This signup process will create four accounts automatically for you:

1. Muleforge (to commit code),
2. Confluence (to write documentation for a project)
3. JIRA (used to track issues related to a project)
4. Jive (to post message on a project's forum)

A Single Sign On for all the applications used by MuleForge will be provided in a future release of MuleForge. Currently, the accounts are created initially when registering, but you have to log in for each application you use.

It tends to be easier to manage your accounts if you stick to the same username for all accounts, although this is not compulsory!

When signing up, you may note that there is no field where to enter your username for the Jive forum account. The same username used for the MuleForge account will be used.

After registering, you will receive an email with a URL for activating your MuleForge account. After verifying the email address, all other accounts will also be set up shortly.

Log into your MuleForge Account

If you ALREADY have an account on MuleForge:

• Click 'ADMIN' from the top navigation bar.
• Click 'Login' at the top right hand side of the page.

Propose a New Project

If you have an idea which would be useful as a Mule extension, then fill an online form for proposing a new MuleForge project. The form may be accessed in one of two easy ways:

• Click 'CONTRIBUTE' from the top navigation bar. OR
• Click 'Contribute a Project' from the MuleForge homepage.

Own a Project

Only registered users may become project owners. If you haven't already signed up for a MuleForge account, please do so by following the section above 'Register for a MuleForge Account'.

If you would like to own a proposed project which currently has no owner,

• View the list of projects (by clicking 'PROJECTS' from top navigation bar).
• Hit the 'Own me' button next to the project you would like to own.

Become a Member (Developer) of a Particular Project

Being a developer requires you to have a MuleForge account. If you haven't already registered, please do so by following the section above 'Register for a MuleForge Account'.

If you would like to be included as a developer of an existing project:

• Go to the homepage of a project.
• Click 'Project Members' from the left navigation bar, under the 'Project Resources' heading. This takes you to the MuleForge Admin.
• Click the last link 'Apply to join as a developer' from the left navigation bar, under the 'Membership' heading. The project despot will then review your request and should contact you via email.

Being a project developer allows you to commit code and documentation to the project.