Download RESTx
Download and install
Getting RESTx
RESTx is an open-source project, available under the GPLv3 license. To install and run it, you need at least a Java 6 JRE (Java Runtime Environment). If you wish to develop your own Java components then you also require a Java compiler.
The RESTx download is compact and contains all source files, install and control scripts you need. RESTx itself is completely stand alone, so no further framework or server is required.
You have two options to get RESTx:
Option 1: The latest official version
The latest official version of RESTx is available as TAR ball or ZIP archive.
- Download RESTx-0.9.4.tar.gz or RESTx-0.9.4.zip
- Unpack and go to the install directory. For example:
% tar zxvf RESTx-0.9.4.tar.gz
% cd RESTx-0.9.4
The archive contains pre-build JAR files, so you can start RESTx even if you do not have a Java compiler available.
Option 2: The latest development version
The latest and freshest sources for RESTx are available from our repository. To access it, you need git version control system. You can get a clone of our repository with this command:
% git clone git://github.com/mulesoft/RESTx.git
% cd RESTx
Please note that this gives you all the same tools and support scripts as the archive. However, the JAR file for RESTx is not included. Therefore, during installation a Java compiler is needed.
The fact that you chose the repository indicates that you have an interest in the source files. We welcome contributions from the developer community. If you would like to contribute to RESTx, please take a look at our contributor information.
Installation
You are now in the RESTx directory (either 'RESTx' or 'RESTx-0.9.4' depending on your mode of download), ready to install RESTx.
The following instructions are for Linux/Unix. Click here for Windows installation instructions.
RESTx comes with a convenient installer script. You don't have to be a root or an admin user to run it. If you are using a Linux system, all you have to type is:
% ./install.sh
The installer performs necessary checks and auto-installs (locally) any required software. It might ask you a few questions along the way. Please also see the detailed guide to the installer.
Starting the server
Once the install is completed, you can start the RESTx server. For Linux there is a convenient script:
% ./restxctl start
This starts the server in the foreground, with logging output directed to the console. For more choices see the detailed description of server start options.
For Windows instructions on how to start the server, please go here.
Accessing the server
You can access and explore the server by directing your web-browser to: http://localhost:8001
We invite you to follow a guided tour of the RESTx server with your browser.
What's next?
Our documentation page holds a lot of useful information. A few highlights you may be interested in: