Download from Website
The Metamug Console can be downloaded from https://metamug.com/dl as a zip or tar file in the case of Linux. You can select the appropriate version depending on your operating system.
Connect using SSH
If you are connecting to your remote server using
ssh terminal, you can make use of
wget the command to directly download the zip/tar file. If you follow the guide for AWS EC2 SSH access or CPanel SSH access depending on whether your server is hosted on AWS cloud or CPanel based hosting.
Download from CloudFront and Run
mkdir api-server cd api-server wget https://d26z0jouibnunt.cloudfront.net/download/metamug-linux-x64-1.5.6.tar.gz tar -xvf metamug-linux-x64-1.5.6.tar.gz cd metamug-linux-x64-1.5.6/METAMUG_CONSOLE/bin sudo sh catalina.sh start
After extracting, you will obtain a folder named
METAMUG_CONSOLE inside which you will find the
bin folder mentioned in the rest of this article and other required files and folders.
You can navigate to
METAMUG_CONSOLE/bin folder for starting/stopping the server.
How to start/stop the server
The console runs as a server and can be started using the following commands:
Navigate to the
\bin folder and run the following
For starting the server.
For Stopping the server.
Navigate to the
/bin folder and run the following
For starting the server
sudo sh catalina.sh start
For starting the server on the main thread of the terminal, this will show the logs on the terminal screen
sudo sh catalina.sh run
For stopping the server
sudo sh catalina.sh stop
It is recommended to run the server as root using
sudoto prevent any file permission issues.
Note: The above scripts can be executed using
sh instead of
bash but we do not recommend doing so as the
sh command may not completely run all the required scripts and may cause unpredictable behaviour.
Setting heap size for Java runtime
For Windows, Open
/bin/setenv.bat and locate the following line in the file
set "JAVA_OPTS=%JAVA_OPTS% -Xms512m -Xmx2048m"
Xms and Xmx represents the minimum and maximum value in mb respectively. You can modify the values according to your requirements
For Max/Linux, open
/bin/setenv.sh and locate the following lines in the file
export CATALINA_OPTS="$CATALINA_OPTS -Xms1024m" export CATALINA_OPTS="$CATALINA_OPTS -Xmx2048m"
Point your browser at http://localhost:7000/console You should see the launch page of Metamug.
- Login into your account using the default credentials given above and voila! You're ready to use the Metamug Console.
username: admin password: admin
You'll need an internet connection to download updates later. Otherwise, you can use a console without the internet.
PDF Guide is available online at:
A common startup problem is when another program has claimed port 7000, which Metamug is configured to run on by default. To avoid this port conflict, Metamug's port can be changed in
If you encounter any problems, please create a support request at: firstname.lastname@example.org
Start Building REST APIs
Once you get the Metamug Console running, you can create a backend connected to your database, save a resource and your REST API will be deployed within seconds!
The API will be available at
Read this for more on making API requests.
Ask at Stackoverflow for Metamug: