Skip to content

Commit 50e2403

Browse files
committed
docs: update documentation to reflect new cli flags to load repositories
Signed-off-by: Manuel Carmona <[email protected]>
1 parent 9dcd907 commit 50e2403

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

docs/using-gitbase/configuration.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -57,27 +57,27 @@ Usage:
5757
5858
Starts a gitbase server instance
5959
60-
By default when gitbase encounters and error in a repository it
60+
By default when gitbase encounters an error in a repository it
6161
stops the query. With GITBASE_SKIP_GIT_ERRORS variable it won't
6262
complain and just skip those rows or repositories.
6363
6464
Help Options:
65-
-h, --help Show this help message
65+
-h, --help Show this help message
6666
6767
[server command options]
68-
-v Activates the verbose mode
69-
-g, --git= Path where the git repositories are located, multiple directories can
70-
be defined. Accepts globs.
71-
--siva= Path where the siva repositories are located, multiple directories can
72-
be defined. Accepts globs.
73-
--host= Host where the server is going to listen (default: localhost)
74-
-p, --port= Port where the server is going to listen (default: 3306)
75-
-u, --user= User name used for connection (default: root)
76-
-P, --password= Password used for connection
77-
--pilosa= URL to your pilosa server (default: http://localhost:10101)
78-
[$PILOSA_ENDPOINT]
79-
-i, --index= Directory where the gitbase indexes information will be persisted.
80-
(default: /var/lib/gitbase/index) [$GITBASE_INDEX_DIR]
81-
--no-squash Disables the table squashing.
82-
--trace Enables jaeger tracing [$GITBASE_TRACE]
83-
```
68+
-v Activates the verbose mode
69+
-d, --directories= Path where the git repositories are located (standard and siva), multiple directories can be defined. Accepts globs.
70+
--depth= load repositories looking at less than <depth> nested subdirectories. (default: 1000)
71+
--no-git disable the load of git standard repositories.
72+
--no-siva disable the load of siva files.
73+
--host= Host where the server is going to listen (default: localhost)
74+
-p, --port= Port where the server is going to listen (default: 3306)
75+
-u, --user= User name used for connection (default: root)
76+
-P, --password= Password used for connection
77+
--pilosa= URL to your pilosa server (default: http://localhost:10101) [$PILOSA_ENDPOINT]
78+
-i, --index= Directory where the gitbase indexes information will be persisted. (default: /var/lib/gitbase/index) [$GITBASE_INDEX_DIR]
79+
--no-squash Disables the table squashing.
80+
--trace Enables jaeger tracing [$GITBASE_TRACE]
81+
-r, --readonly Only allow read queries. This disables creating and deleting indexes as well. [$GITBASE_READONLY]
82+
83+
```

docs/using-gitbase/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ For more info about command line arguments, [go here](/docs/using-gitbase/config
1616
You can start a server by providing a path which contains multiple git repositories `/path/to/repositories` with this command:
1717

1818
```
19-
$ gitbase server -v -g /path/to/repositories
19+
$ gitbase server -v -d /path/to/repositories
2020
```
2121

2222
## Installing from source
@@ -83,4 +83,4 @@ As of MySQL 8.0 [the default authentication method is `caching_sha2_password`](h
8383

8484
```
8585
mysql -q -u root -h 127.0.0.1 --default-auth=mysql_native_password
86-
```
86+
```

0 commit comments

Comments
 (0)