Startup and Shutdown
- Obtain usage information
- Startup commands
- Shutdown commands
- Parameters
- Starting and stopping multiple App Studio instances
- What’s next
App Studio has two scripts for startup and shutdown in the root directory of an App Studio project (app-studio
):
-
app-studio.sh
– A Bash script for Linux and macOS -
app-studio.bat
– A batch file for Windows
You also use these scripts to build an app from source.
Obtain usage information
For usage information, enter:
-
Linux and macOS:
./app-studio.sh -help
-
Windows:
app-studio.bat -help
For command-specific usage information, enter:
-
Linux and macOS:
./app-studio command -help
-
Windows:
app-studio.bat command -help
Below, optional parameters are indicated by square brackets, which you don’t type.
Startup commands
-
Linux and macOS:
./app-studio start [--production] [-f] [-p port] [-m memory] [-t timeout] [-V]
-
Windows:
app-studio.bat start [-f] [-p port] [-m memory] [-t timeout] [-V]
Shutdown commands
-
Linux and macOS:
./app-studio stop [-p port] [-V]
-
Windows:
app-studio.bat stop [-p port] [-V]
Parameters
Bold italic text is a placeholder for a value. For example, for -m memory
you might use -m 4g
.
Parameter | Description |
---|---|
|
Start the app in production mode, which disables the configuration wizard and the code editor. |
|
Start App Studio in the foreground. By default, App Studio starts in the background. |
|
Specify the port on which the App Studio web server will listen. The default port is 8080. |
|
Set the minimum (-Xms) and maximum (-Xmx) heap size for the JVM. For example, |
|
Set the startup timeout in seconds. |
|
Output verbose messages from the script. |
Starting and stopping multiple App Studio instances
You can run multiple instances of App Studio on a single host by specifying different ports for all instances. Do this on startup, at the command line, using the -p
parameter, for example:
./app-studio.sh start -p 9000
When running multiple instances, also use the -p
flag to indicate which instance of App Studio to shut down, for example:
./app-studio.sh stop -p 9000
What’s next
-
See Create a New Web App to learn how to create your first search app.
-
See Customizing Your Application to learn about App Studio’s markup templating language and how app pages are constructed.