Make the binary package more quick start friendly
- Dominant language
- C++
- Stars
- 16.7k
- Forks
- 1.6k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 126
Description
It would be nice if the binary package included a single command to start a local FoundationDB server.
_Description:_
As a developer I want an easy way to run a local database for development and testing.
The "Getting Started on Linux" instructions assume that I will install a distro package, which isn't always possible or desired, e.g. in my case my distro is not supported.
The binaries tarball works but is a bit of hassle to get running, as you need to find the following:
- a config file, which you can piece together from the documentation section by section
- a cluster file, whose format is described but without a valid example or suggested way to generate an ID
- a command line, e.g. do you run fdbmonitor or fdbserver, and with which arguments
(For a comparison, the relatively heavy-weight Kafka comes ready to run locally in two commands, one of which starts an included Zookeeper server.)
_Suggestion:_
The binary package should include a shell script that starts a local foundationdb server, creating a cluster file if necessary.
The server should be configured to store its data and logs to the local directory.
It should also include a readme file that shows how to start the server and connect to it with fdbcli.
Contributor guide
Research direction
Start by inspecting the binary package contents and the existing “Getting Started on Linux” instructions, including the documented fdbmonitor, fdbserver, cluster file, and configuration steps. Done means the package includes a command that creates a cluster file when needed, stores data and logs locally, and a README showing how to start the server and connect with fdbcli.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- cli, documentation, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100