{"parents": [], "prev": {"link": "../configuration/", "title": "Configuring Review Board Gateway"}, "next": null, "title": "Running rb-gateway", "meta": {}, "body": "
\n

# Running rb-gateway\u00b6

\n

Once `rb-gateway` is installed and\nconfigured, start the server with the\n`serve` command:

\n

    $ ./rb-gateway serve\n

\n
\n

By default, this reads `config.json` from the current directory. Use\n`--config` to specify a different path:

\n

    $ ./rb-gateway --config /etc/rb-gateway/config.json serve\n

\n
\n

The server reloads its configuration automatically when the config file\nchanges or when it receives `SIGHUP`. Send `SIGINT` or `SIGTERM` to\nshut down gracefully.

\n
\n

## Commands\u00b6

\n

`rb-gateway` supports the following commands:

\n

\n
`serve`

  Start the API server. This is the default if no command is given.

  \n
\n
`trigger-webhooks <repository> <event>`

  Trigger matching webhooks for a repository and event.

  \n
\n
`reinstall-hooks`

  Re-install hook scripts for all repositories.

  \n
\n

\n

The version can be printed with `--version`:

\n

    $ ./rb-gateway --version\n

\n
\n
\n
\n

## Running rb-gateway as a Service\u00b6

\n

It\u2019s likely that you\u2019ll want to run `rb-gateway` as a service that starts\nwhen you boot the server. There are many ways of doing this depending on your\nparticular environment, but one of the more common ones is systemd. The below\nunit file example can be customized with the location of the rb-gateway binary\nand your config file:

\n

    [Unit]\nDescription=Review Board Gateway\nAfter=network.target\n\n[Service]\nUser=rb-gateway\nKillSignal=SIGTERM\nExecStart=/usr/local/bin/rb-gateway --config /etc/rb-gateway/config.json serve\nExecReload=/bin/kill -HUP $MAINPID\n\n[Install]\nWantedBy=multi-user.target\n

\n
\n
\n
\n", "metatags": "\n", "rellinks": [["genindex", "General Index", "I", "index"], ["configuration/index", "Configuring Review Board Gateway", "P", "previous"]], "sourcename": "running/index.rst.txt", "toc": "

\n
- Running rb-gateway
  \n
  - Commands
  \n
  - Running rb-gateway as a Service
  \n
  \n
\n

\n", "display_toc": true, "page_source_suffix": ".rst", "current_page_name": "running/index", "sidebars": ["relations.html", "searchbox.html"], "alabaster_version": "0.7.16", "alabaster_version_info": [0, 7, 16]}