-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add an article explaining how to install
protoc
Motivation: The official instructions for installing `protoc` don't include instructions for using a package manager. A number of our docs refernce having `protoc` installed as a prerequisite, it'd be useful to have docs on how to install using a package manager. Modifications: - Add a doc about installing protoc Result: More docs
- Loading branch information
Showing
2 changed files
with
66 additions
and
1 deletion.
There are no files selected for viewing
59 changes: 59 additions & 0 deletions
59
Sources/GRPCProtobuf/Documentation.docc/Articles/Installing-protoc.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Installing protoc | ||
|
||
Learn how to install `protoc`, the Protocol Buffers compiler. | ||
|
||
## Overview | ||
|
||
The Protocol Buffers compiler is a command line tool for generating source code from `.proto` | ||
files and is required to generate gRPC stubs and messages. You can learn more about it on the | ||
[Protocol Buffers website](https://protobuf.dev/). | ||
|
||
You can install `protoc` in a number of ways including: | ||
|
||
1. Via a package manager, | ||
2. By downloading the binary. | ||
|
||
### Install via a package manager | ||
|
||
Using a package manager is the easiest way to install `protoc`. | ||
|
||
On macOS you can use [Homebrew](https://brew.sh): | ||
|
||
```sh | ||
brew install protobuf | ||
``` | ||
|
||
On Ubuntu and Debian you can use `apt`: | ||
|
||
```sh | ||
apt update && apt install -y protobuf-compiler | ||
``` | ||
|
||
On Fedora you can use `dnf`: | ||
|
||
```sh | ||
dnf install -y protobuf-compiler | ||
``` | ||
|
||
### Installing a pre-built binary | ||
|
||
If you're unable to use a package manager to install `protoc` then you may be able | ||
to download a pre-built binary from the [Protocol Buffers GitHub | ||
repository](https://github.com/protocolbuffers/protobuf). | ||
|
||
First, find and download the appropriate binary for your system from the | ||
[releases](https://github.com/protocolbuffers/protobuf/releases) page. | ||
|
||
Next, unzip the artifact to a directory called `protoc`: | ||
|
||
```sh | ||
unzip /path/to/downloaded/protoc-{VERSION}-{OS}.zip -d protoc | ||
``` | ||
|
||
Finally, move `protoc/bin/protoc` to somewhere in your `$PATH` such as `/usr/local/bin`: | ||
|
||
```sh | ||
mv protoc/bin/protoc /usr/local/bin | ||
``` | ||
|
||
You can now remove the `protoc` directory. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters