extern/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2024-11-25 17:43:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #30 from andpar83/signal-doc

Browse Source 
Fix Signal doc styling
This commit is contained in:
Maycon Santos 2021-06-15 08:52:17 +02:00 committed by GitHub
commit 2784f6a098
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
signal/README.md
View File

@ -1,18 +1,23 @@
# Wiretrustee Signal Server
This is a Wiretrustee signal-exchange server and client library to exchange connection information between Wiretrustee Trusted Device and Wiretrustee Hub This is a Wiretrustee signal-exchange server and client library to exchange connection information between Wiretrustee Trusted Device and Wiretrustee Hub
The project uses gRPC library and defines service in protobuf file located in: The project uses gRPC library and defines service in protobuf file located in:
```proto/signal_exchange.proto``` ```proto/signal_exchange.proto```
To build the project you have to do the following things. To build the project you have to do the following things.
Install protobuf version 3 (by default v3 is installed on ubuntu 20.04. On previous versions it is proto 2): Install protobuf version 3 (by default v3 is installed on ubuntu 20.04. On previous versions it is proto 2):
```
```bash
#!/bin/bash
sudo apt install protoc-gen-go sudo apt install protoc-gen-go
sudo apt install golang-goprotobuf-dev sudo apt install golang-goprotobuf-dev
``` ```
Generate gRPC code:
```
protoc -I proto/ proto/signalexchange.proto --go_out=plugins=grpc:proto
``` Generate gRPC code:
```bash
#!/bin/bash
protoc -I proto/ proto/signalexchange.proto --go_out=plugins=grpc:proto
```