Skip to content

Commit

Permalink
doc: add a note about box.cfg.background usage
Browse files Browse the repository at this point in the history
@TarantoolBot document
Title: User should not to set `box.cfg.background = true` with `tt start`

`tt start` daemonizes a Tarantool process itself. The `box.cfg.background`
setting does the same thing from a Tarantool process. These features
conflict with each other. As a result, `tt status` shows an invalid
status of a Tarantool instance, and it is unable to stop the instance
with `tt stop`.

A user should never set `box.cfg.background = true` in an application
code that is started by `tt`.

Closes #780
  • Loading branch information
oleg-jukovec authored and psergee committed Mar 6, 2024
1 parent de2af1c commit c9b70e2
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Tarantool-based applications.
* [Setting Tarantool configuration parameters via environment variables](#setting-tarantool-configuration-parameters-via-environment-variables)
* [Add current environment binaries location to the PATH variable](#add-current-environment-binaries-location-to-the-path-variable)
* [Migration from older TT versions](doc/migration_from_older_versions.md)
* [Known issues](doc/known_issues.md)
* [Commands](#commands)

## Intro
Expand Down
22 changes: 22 additions & 0 deletions doc/known_issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Known issues

The file includes built-in errors we expect people to encounter and common
problems reported by users. For the latest list of all issues see
the [Github Issues page](https://github.com/tarantool/tt/issues).

## Contents

* [Do not set the box.cfg.background](#do-not-set-the-boxcfgbackground)

## Do not set the box.cfg.background

`tt start` daemonizes a Tarantool process itself. The [box.cfg.background
setting][cfg-background] does the same thing from a Tarantool process. These
features conflict with each other. As a result, `tt status` shows an invalid
status of a Tarantool instance, and it is unable to stop the instance
with `tt stop`.

You should never set `box.cfg.background = true` in an application code that
is started by `tt`.

[cfg-background]: https://www.tarantool.io/en/doc/latest/reference/configuration/#confval-background

0 comments on commit c9b70e2

Please sign in to comment.