Skip to content

Commit 14eb564

Browse files
author
Shlomi Noach
authored
Merge pull request #94 from github/documentation
More documentation updates
2 parents 53508af + a0e10a1 commit 14eb564

File tree

2 files changed

+23
-1
lines changed

2 files changed

+23
-1
lines changed

README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,19 @@ Pronounce: _ghost_
7575

7676
`gh-ost` is released at a stable state, but with mileage to go. We are [open to pull requests](https://github.com/github/gh-ost/blob/master/.github/CONTRIBUTING.md). Please first discuss your intentions via [Issues](https://github.com/github/gh-ost/issues).
7777

78-
We develop `gh-ost` at GitHub and for the community. We may have different priorities than others. From time to time we may suggest a contribution that is not on our immediate roadmap but which may appeal to others.
78+
We develop `gh-ost` at GitHub and for the community. We may have different priorities than others. From time to time we may suggest a contribution that is not on our immediate roadmap but which may appeal to others.
79+
80+
## Download/binaries/source
81+
82+
`gh-ost` is now GA and stable.
83+
84+
`gh-ost` is available in binary format for Linux and Mac OS/X
85+
86+
[Download latest release here](https://github.com/github/gh-ost/releases/latest)
87+
88+
`gh-ost` is a Go project; it is built with Go 1.5 with "experimental vendor". Soon to migrate to Go 1.6. See and use [build file](https://github.com/github/gh-ost/blob/master/build.sh) for compiling it on your own.
89+
90+
Generally speaking, `master` branch is stable, but only [releases](https://github.com/github/gh-ost/releases) are to be used in production.
7991

8092
## Authors
8193

doc/what-if.md

+10
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,13 @@ There is a `lock_wait_timeout` explicitly associated with the cut-over operation
3030
This is where `gh-ost` shines. There is no need to kill it as you may be used to with other tools. You can reconfigure `gh-ost` [on the fly](https://github.com/github/gh-ost/blob/master/doc/interactive-commands.md) to be nicer.
3131

3232
You're always able to actively begin [throttling](throttle.md). Just touch the `throttle-file` or `echo throttle` into `gh-ost`. Otherwise, reconfigure your `max-load`, the `nice-ratio`, the `throttle-query` to gain better thresholds that would suit your needs.
33+
34+
### What if my replicas don't use binary logs?
35+
36+
If the master is running Row Based Replication (RBR) - point `gh-ost` to the master, and specify `--allow-on-master`. See [cheatsheets](cheatsheets.md)
37+
38+
If the master is running Statement Based Replication (SBR) - you have no alternative but to reconfigure a replica with:
39+
40+
- `log_bin`
41+
- `log_slave_updates`
42+
- `binlog_format=ROW`

0 commit comments

Comments
 (0)