Requirements

NwaySP is running or was tested on :

Configuration Requirements
Operating System Linux (Debian, BSD, ...) and OSX : Notice that all our integration tests are made on Debians
CPU Minimum of 2 Ghz (Works better on multi-core)
Ram and Swap Minimum of 4 GB (It can run on 2GB or even 1GB, but you need to be aware that you can have some performance issues.)
Hard Drive Space Minimum of 10 GB (A lot of logs can be generated.)
Database (Optional) H2 or PostgreSQL greater 8.3

Notice that the more you have services, the more resources NwaySP will consume. Please check carefully you System resources in order to track peaks of loads. Try to determine what is limiting the system from going faster or smoother (memory, swap, CPU, network, ...).

Please check Optimization Page to improve performance for your needs.

Package Description

After unzipping the package, you should have this structure :

  • bin/ : Binary that are used to launch NwaySP Server or Command Line Tool.
    • nwaysp_cmd_console.sh : Command Line Tool Executor
    • nwaysp_web_console.sh : Command Line Tool Executor
    • nwayspd.sh : Server (Engine) Executor
  • conf/ : Directory that is containing configuration of all the applications (Command Line Tool, Engine and Web Console)
    • common/ : Commonly loaded configuration
      • common.properties : Common configurations for all the applications.
      • db.properties : Database configurations.
      • ehcache.xml : EH cache configuration. More detail here
    • cmd/ : Command Line Tool configurations.
      • nsp.properties : Main configuration of the Command Line Tool.
      • logback.xml : Logging configuration using LogBack. More detail here.
    • server/ : Servers (Engine) configurations.
      • common/ :
      • [CONTEXT]/ : Server called "CONTEXT" configuration
        • activemq.xml : Configuration of XML Embedded broker. More detail here.
        • quartz.properties : Configuration of quartz Embedded Scheduler. More detail here.
        • sp.properties : Main configuration of a Server
        • default-container.xml : Common configuration of each Service
    • web/ : Web Console configurations.
  • lang/ : Directory that contain language information of server launcher (wrapper) launcher.
  • lib/ : Libraries of Command line tool, Servers and Services.
    • boot/ : Libraries and executables for server launcher (wrapper) launcher.
    • core/ : Libraries considering core elements of Command line tool, Servers and Services
    • server/ : Libraries of the servers (engines)
    • services/ : Libraries os Services
    • shared/ : Misc Libraries loaded by all the items.
    • user/ : User Libraries - Put here any additional library that you want to load.
  • logs/ : Log directory for different items.
    • cmd/ : Log directory for command line tools
    • server/ : Log directory for Servers (Engines).
      • [CONTEXT]/ : Log directory for a server (Engine) that has the context "CONTEXT"
  • webapps/ : Web Application that will be loaded at startup of any engine.
    • melody/ : Web Application that allows to monitor any java application. For more detail have a look at this page.
  • target/ : Output directory for different items.
    • cmd/ : Output directory for command line tools.
    • server/ : Output directory for Servers (Engines)
      • [CONTEXT]/ : Output directory for a server (Engine) that has the context "CONTEXT"
        • import/ : At startup, a server (engine) will automatically import any XML file that are in these folders. If there is an error on one of the later, startup will fail.
        • hotimport/ : At runtime, hot importing of files
  • temp/ : Temporary directory for different items.
    • cmd/ : Temporary directory for command line tool.
    • server/ : Temporary directory for Servers (Engines).
      • [CONTEXT]/ : Temporary directory for a server (Engine) that has the context "CONTEXT".
  • tools/ : These are some tools that can be useful.
  • web/ : This is a basic Tomcat 7 installation.

Server (Engine) Launching

Default context is called "default".

To Launch a Server (Engine), you just have to execute :

bin/nwayspd.sh start

To Stop a Server (Engine)

bin/nwayspd.sh stop

To Know the status of a Server (Engine)

bin/nwayspd.sh status

If you want to precise a context

bin/nwayspd.sh start default bin/nwayspd.sh stop default bin/nwayspd.sh status default

Web Console Launching

To launch the Web Console, process as if you were launching a regular Tomcat 7 application.

bin/nwaysp_web_console.sh

OR

web/bin/catalina.sh start

Command Line Tools

To launch command line tool, you just have to execute :

bin/nwaysp_cmd_console.sh help