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: modules/express/README.md
+13-15Lines changed: 13 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
1
# BitGo Express local signing server (REST API)
2
2
3
-
Suitable for developers working in a language without an official BitGo SDK.
3
+
BitGo Express is suitable for developers working in a language without an official BitGo SDK.
4
4
5
5
BitGo Express runs as a service in your own datacenter, and handles the client-side operations involving your own keys, such as partially signing transactions before submitting to BitGo. This ensures your keys never leave your network, and are not seen by BitGo. BitGo Express can also proxy the standard BitGo REST APIs, providing a unified interface to BitGo through a single REST API.
6
6
7
7
# Documentation
8
8
9
-
View the comprehensive documentation on the BitGo [Developer Portal](https://developers.bitgo.com/docs/get-started-express-install/).
9
+
View comprehensive documentation on the BitGo [Developer Portal](https://developers.bitgo.com/docs/get-started-express-install/).
10
10
11
11
# Running BitGo Express
12
12
13
13
## Docker
14
14
15
-
For most users, we recommend running BitGo Express as a docker container, since this is the most secure way to run BitGo Express.
15
+
For most users, we recommend running BitGo Express as a Docker container, since this's the most secure way to run BitGo Express.
16
16
17
17
> Deprecation Warning: bitgosdk/express will no longer receive updates. Please use the official bitgo/express images.
An alternative way to provide the ssl certification is to export them as environment variables.
81
+
An alternative way to provide the SSL certification is to export them as environment variables.
82
82
83
83
```bash
84
84
$ export BITGO_SSL_KEY=$(cat /private/cert.key)
@@ -97,9 +97,9 @@ Environment: prod
97
97
Base URI: https://0.0.0.0:4000
98
98
```
99
99
100
-
### Building the docker container
100
+
### Building the Docker container
101
101
102
-
If you'd like to build the BitGo Express docker container yourself from the source code, first check out the latest **master** branch, then run `docker build` from the project root. Here's the commands:
102
+
To build the BitGo Express Docker container yourself from the source code, check out the latest **master** branch and run `docker build` from the project root.
Another way to build the BitGo Express docker container if you have `yarn` installed:
111
+
You can also build the BitGo Express Docker container using `yarn`:
112
112
113
113
```bash
114
114
$ git clone https://github.com/bitgo/bitgojs
@@ -119,17 +119,15 @@ $ docker run -it bitgo-express:latest
119
119
120
120
## From source
121
121
122
-
For users who are unable to run BitGo Express as a docker container, we recommend building and running from the source code.
122
+
For users who are unable to run BitGo Express as a Docker container, we recommend building and running from the source code.
123
123
124
124
### Prerequisites
125
125
126
-
Please make sure you are running at least Node version 16.
127
-
We recommend using `nvm`, the [Node Version Manager](https://github.com/creationix/nvm/blob/master/README.markdown#installation), for setting your Node version.
128
-
BitGo Express has become a first class citizen of the monorepo so we recommend using `yarn` for local setup.
126
+
Ensure you're running at least Node version 16. We recommend using `nvm`, the [Node Version Manager](https://github.com/creationix/nvm/blob/master/README.markdown#installation), for setting your Node version. BitGo Express has become a first class citizen of the monorepo so we recommend using `yarn` for local setup.
129
127
130
128
### Cloning the repository and installing dependencies
131
129
132
-
First, clone the latest **master** branch, then run `yarn install` in the project root directory.
130
+
Clone the latest **master** branch and run `yarn install` in the project root directory.
From the express module folder (`modules/express`), run this command:
140
+
From the Express module folder (`modules/express`), run this command:
143
141
144
142
```bash
145
143
$ yarn run start
@@ -234,7 +232,7 @@ BitGo Express is able to take configuration options from either command line arg
234
232
| N/A | --disableproxy |`BITGO_DISABLE_PROXY` <sup>0</sup> | N/A | Disable proxying of routes not explicitly handled by bitgo-express |
235
233
| N/A | --disableenvcheck |`BITGO_DISABLE_ENV_CHECK` <sup>0</sup> | N/A | Disable checking for correct `NODE_ENV` environment variable when running against BitGo production environment. |
236
234
| -i | --ipc |`BITGO_IPC`| N/A | If set, bind to the given IPC (unix domain) socket. Binding to an IPC socket can be useful if the caller of bitgo-express resides on the same host as the bitgo-express instance itself, since the socket can be secured using normal file permissions and ownership semantics. Note: This is not supported on Windows platforms. |
237
-
| N/A | --authversion |`BITGO_AUTH_VERSION`| 2 | BitGo Authentication scheme version which should be used form making requests to the BitGo server. Please see the [BitGo API documentation](https://app.bitgo.com/docs) for more info on authentication scheme versions. |
235
+
| N/A | --authversion |`BITGO_AUTH_VERSION`| 2 | BitGo Authentication scheme version which should be used form making requests to the BitGo server. For more info on authentication scheme versions, view the API reference on the BitGo [Developer Portal](https://developers.bitgo.com/reference/overview#/). |
238
236
| N/A | --externalSignerUrl |`BITGO_EXTERNAL_SIGNER_URL`| N/A | URL specifying the external API to call for remote signing. |
239
237
| N/A | --signerMode |`BITGO_SIGNER_MODE `| N/A | If set, run Express as a remote signer. |
240
238
| N/A | --signerFileSystemPath |`BITGO_SIGNER_FILE_SYSTEM_PATH `| N/A | Local path specifying where an Express signer machine keeps the encrypted user private keys. Required when signerMode is set. |
0 commit comments