Skip to content

Commit a80cc08

Browse files
authored
Merge pull request #459 from erizocosmico/docs/copyable-snippets
docs: make some snippets copyable
2 parents 63901f6 + 74ef7a5 commit a80cc08

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

docs/using-gitbase/getting-started.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,35 @@ The easiest way to run the gitbase server is using Docker, however you have the
1515

1616
You can use the official image from [docker hub](https://hub.docker.com/r/srcd/gitbase/tags/) to quickly run gitbase:
1717
```
18-
$ docker run --rm --name gitbase -p 3306:3306 -v /my/git/repos:/opt/repos srcd/gitbase:latest
18+
docker run --rm --name gitbase -p 3306:3306 -v /my/git/repos:/opt/repos srcd/gitbase:latest
1919
```
2020

2121
If you want to speedup gitbase using indexes you must run a pilosa container:
2222
```
23-
$ docker run -it --rm --name pilosa -p 10101:10101 pilosa/pilosa:v0.9.0
23+
docker run -it --rm --name pilosa -p 10101:10101 pilosa/pilosa:v0.9.0
2424
```
2525

2626
Then link the gitbase container to the pilosa one:
2727
```
28-
$ docker run --rm --name gitbase -p 3306:3306 --link pilosa:pilosa -e PILOSA_ENDPOINT="http://pilosa:10101" -v /my/git/repos:/opt/repos srcd/gitbase:latest
28+
docker run --rm --name gitbase -p 3306:3306 --link pilosa:pilosa -e PILOSA_ENDPOINT="http://pilosa:10101" -v /my/git/repos:/opt/repos srcd/gitbase:latest
2929
```
3030

31+
**Note:** remember to replace `/my/git/repos` with the local path where your repositories are stored in your computer.
32+
3133
### Download and use the binary
3234

3335
Check the [Releases](https://github.com/src-d/gitbase/releases) page to download the gitbase binary.
3436

3537
For more info about command line arguments, [go here](/docs/using-gitbase/configuration.md#command-line-arguments).
3638

37-
You can start a server by providing a path which contains multiple git repositories `/path/to/repositories` with this command:
39+
You can start a server by providing a path which contains multiple git repositories with this command:
3840

3941
```
40-
$ gitbase server -v -d /path/to/repositories
42+
gitbase server -v -d /path/to/repositories
4143
```
4244

45+
**Note:** remember to replace `/path/to/repositories` with the local path where your repositories are stored in your computer.
46+
4347
### Installing from source
4448

4549
On Linux and macOS:
@@ -53,9 +57,9 @@ On Windows:
5357
Because gitbase uses [bblfsh's client-go](https://github.com/bblfsh/client-go), which uses cgo, you need to install some dependencies by hand instead of just using `go get`. Use this instead:
5458

5559
```
56-
$ go get -d github.com/src-d/gitbase
57-
$ cd $GOPATH/src/github.com/src-d/gitbase
58-
$ make dependencies
60+
go get -d github.com/src-d/gitbase
61+
cd $GOPATH/src/github.com/src-d/gitbase
62+
make dependencies
5963
```
6064

6165
## Connecting to the server

0 commit comments

Comments
 (0)