You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-7Lines changed: 20 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,7 @@
11
11
- High performance.
12
12
- Fully usable with TypeScript (3+).
13
13
- Compatible with Zeromq 4/5 via "zeromq/v5-compat"
14
+
- Secure Curve protocol with Libsodium
14
15
15
16
## Useful links
16
17
@@ -90,17 +91,24 @@ to start a build from source.
90
91
91
92
### Building from source
92
93
93
-
If a prebuilt binary is unavailable or if you want to pass certain options
94
+
If a prebuilt binary is unavailable, or if you want to pass certain options
94
95
during build, you can build this package from source.
95
96
96
97
Make sure you have the following installed before attempting to build from
97
98
source:
98
99
99
100
- Node.js 10+ or Electron
100
-
- A working C++17 compiler toolchain with make
101
-
- Python 3 with Node 10+ (or legacy Python 2.7)
102
-
- CMake 2.8+
103
-
- curl
101
+
- C++17 compiler toolchain (e.g. LLVM, GCC, MSVC)
102
+
- Python 3
103
+
- CMake 3.16+
104
+
- vcpkg dependencies (e.g. on Linux it needs curl, unzip, zip, tar, git,
105
+
pkg-config)
106
+
107
+
For Curve:
108
+
109
+
- automake
110
+
- autoconf
111
+
- libtool
104
112
105
113
To install from source, specify `build_from_source=true` in a `.npmrc` file
106
114
@@ -118,14 +126,19 @@ When building from source, you can also specify additional build options in a
118
126
119
127
### Curve with Libsodium support
120
128
121
-
Enables CURVE security for encrypted communications. Zeromq uses libsodium for CURVE security. To enable CURVE support, add the following to your .npmrc:
129
+
(Enabled by default)
130
+
131
+
Enables CURVE security for encrypted communications. Zeromq uses libsodium for
132
+
CURVE security. To enable CURVE support, add the following to your .npmrc:
122
133
123
134
```ini
124
135
zmq_curve="true"
125
136
zmq_sodium="true"
126
137
```
127
138
128
-
Building libsodium requires these dependencies on Linux/MacOS: `autoconf automake libtool`, which can be installed via `apt-get` or `brew`, etc.
139
+
Building libsodium requires these dependencies on Linux/MacOS:
140
+
`autoconf automake libtool`, which can be installed via `apt-get` or `brew`,
0 commit comments