Skip to content

Commit f4eada5

Browse files
committed
Add more info about gitbase server command
Signed-off-by: Antonio Jesus Navarro Perez <[email protected]>
1 parent c8a5b25 commit f4eada5

File tree

2 files changed

+36
-4
lines changed

2 files changed

+36
-4
lines changed

cmd/gitbase/command/server.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ const (
2323
ServerDescription = "Starts a gitbase server instance"
2424
ServerHelp = ServerDescription + "\n\n" +
2525
"The squashing tables and pushing down join conditions is still a\n" +
26-
"work in progress and unstable,disable by default can be enabled\n" +
26+
"work in progress and unstable, disable by default. It can be enabled\n" +
2727
"using a not empty value at GITBASE_UNSTABLE_SQUASH_ENABLE env variable.\n\n" +
28-
"By default when gitbase encounters and error in a repository it\n" +
28+
"By default when gitbase encounters an error in a repository it\n" +
2929
"stops the query. With GITBASE_SKIP_GIT_ERRORS variable it won't\n" +
3030
"complain and just skip those rows or repositories."
3131
)

docs/using-gitbase/getting-started.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,47 @@
55
Check the [Release](https://github.com/src-d/gitbase/releases) page to download the gitbase binary.
66

77
```bash
8+
Please specify one command of: server or version
89
Usage:
910
gitbase [OPTIONS] <server | version>
1011

1112
Help Options:
1213
-h, --help Show this help message
1314

1415
Available commands:
15-
server Start SQL server.
16-
version Show the version information.
16+
server Starts a gitbase server instance
17+
version Show the version information
18+
```
19+
20+
`server` command contains the following options:
21+
22+
```bash
23+
Usage:
24+
gitbase [OPTIONS] server [server-OPTIONS]
25+
26+
Starts a gitbase server instance
27+
28+
The squashing tables and pushing down join conditions is still a
29+
work in progress and unstable, disable by default. It can be enabled
30+
using a not empty value at GITBASE_UNSTABLE_SQUASH_ENABLE env variable.
31+
32+
By default when gitbase encounters an error in a repository it
33+
stops the query. With GITBASE_SKIP_GIT_ERRORS variable it won't
34+
complain and just skip those rows or repositories.
35+
36+
Help Options:
37+
-h, --help Show this help message
38+
39+
[server command options]
40+
-v Activates the verbose mode
41+
-g, --git= Path where the git repositories are located, multiple directories can be defined. Accepts globs.
42+
--siva= Path where the siva repositories are located, multiple directories can be defined. Accepts globs.
43+
-h, --host= Host where the server is going to listen (default: localhost)
44+
-p, --port= Port where the server is going to listen (default: 3306)
45+
-u, --user= User name used for connection (default: root)
46+
-P, --password= Password used for connection
47+
--pilosa= URL to your pilosa server (default: http://localhost:10101)
48+
-i, --index= Directory where the gitbase indexes information will be persisted. (default: /var/lib/gitbase/index)
1749
```
1850
1951
You can start a server by providing a path which contains multiple git repositories `/path/to/repositories` with this command:

0 commit comments

Comments
 (0)