Skip to content

Server: Running Gruf and Command Line Options

Shaun McCormick edited this page Aug 14, 2022 · 4 revisions

Running gruf is simple, once you've generated some server stubs and created a controller.

Just run this from the command-line:

bundle exec gruf

This will start the server automatically, bind the appropriate controllers, and update the process title with the running status. The binary is receptive to common SIGINT and SIGTERM signals, which will safely shutdown the gRPC server and its thread pool.

Command-Line Options

Gruf comes baked in with a few command-line options for the binstub:

Option Description
-h, --help Displays the help message
-v, --version Displays the gruf version
--host Specify the server binding host
--health-check Serve the default gRPC health check
--services Serve only the passed gRPC service classes
--suppress-default-interceptors Do not use the default interceptors for the server
--backtrace-on-error Push backtraces on exceptions to the error serializer

These options will override whatever is passed in the Gruf configure block or initializer.


Next: Server: Authentication