Skip to content

Commit 3ec7492

Browse files
docs: update README
Ticket: WP-000000
1 parent 205bfca commit 3ec7492

1 file changed

Lines changed: 35 additions & 35 deletions

File tree

README.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -94,32 +94,32 @@ openssl req -new -x509 -key server.key -out server.crt -days 365 -subj "/CN=loca
9494
### 2. Start Enclaved Express
9595

9696
```bash
97-
APP_MODE=enclaved \
98-
KMS_URL=https://your-kms-service \
99-
TLS_KEY_PATH=./server.key \
100-
TLS_CERT_PATH=./server.crt \
101-
MTLS_REQUEST_CERT=true \
102-
ALLOW_SELF_SIGNED=true \
103-
npm run start
97+
export APP_MODE=enclaved
98+
export KMS_URL=https://your-kms-service
99+
export TLS_KEY_PATH=./server.key
100+
export TLS_CERT_PATH=./server.crt
101+
export MTLS_REQUEST_CERT=true
102+
export ALLOW_SELF_SIGNED=true
103+
npm start
104104
```
105105

106-
### 3. Start Master Express
106+
### 4. Start Master Express
107107

108108
In a separate terminal:
109109

110110
```bash
111-
APP_MODE=master-express \
112-
BITGO_ENV=test \
113-
TLS_KEY_PATH=./server.key \
114-
TLS_CERT_PATH=./server.crt \
115-
ENCLAVED_EXPRESS_URL=https://localhost:3080 \
116-
ENCLAVED_EXPRESS_CERT=./server.crt \
117-
MTLS_REQUEST_CERT=false \
118-
ALLOW_SELF_SIGNED=true \
119-
npm run start
111+
export APP_MODE=master-express
112+
export BITGO_ENV=test
113+
export TLS_KEY_PATH=./server.key
114+
export TLS_CERT_PATH=./server.crt
115+
export ENCLAVED_EXPRESS_URL=https://localhost:3080
116+
export ENCLAVED_EXPRESS_CERT=./server.crt
117+
export MTLS_REQUEST_CERT=false
118+
export ALLOW_SELF_SIGNED=true
119+
npm start
120120
```
121121

122-
### 4. Test the Connection
122+
### 5. Test the Connection
123123

124124
Test that Master Express can communicate with Enclaved Express:
125125

@@ -143,28 +143,28 @@ curl -k -X POST https://localhost:3081/ping/enclavedExpress
143143
#### Enclaved Express (Production)
144144

145145
```bash
146-
APP_MODE=enclaved \
147-
KMS_URL=https://production-kms.example.com \
148-
TLS_KEY_PATH=/secure/path/enclaved.key \
149-
TLS_CERT_PATH=/secure/path/enclaved.crt \
150-
MTLS_REQUEST_CERT=true \
151-
ALLOW_SELF_SIGNED=false \
152-
MTLS_ALLOWED_CLIENT_FINGERPRINTS=ABC123...,DEF456... \
153-
npm run start
146+
export APP_MODE=enclaved
147+
export KMS_URL=https://production-kms.example.com
148+
export TLS_KEY_PATH=/secure/path/enclaved.key
149+
export TLS_CERT_PATH=/secure/path/enclaved.crt
150+
export MTLS_REQUEST_CERT=true
151+
export ALLOW_SELF_SIGNED=false
152+
export MTLS_ALLOWED_CLIENT_FINGERPRINTS=ABC123...,DEF456...
153+
npm start
154154
```
155155

156156
#### Master Express (Production)
157157

158158
```bash
159-
APP_MODE=master-express \
160-
BITGO_ENV=prod \
161-
TLS_KEY_PATH=/secure/path/master.key \
162-
TLS_CERT_PATH=/secure/path/master.crt \
163-
ENCLAVED_EXPRESS_URL=https://enclaved.internal.example.com:3080 \
164-
ENCLAVED_EXPRESS_CERT=/secure/path/enclaved.crt \
165-
MTLS_REQUEST_CERT=true \
166-
ALLOW_SELF_SIGNED=false \
167-
npm run start
159+
export APP_MODE=master-express
160+
export BITGO_ENV=prod
161+
export TLS_KEY_PATH=/secure/path/master.key
162+
export TLS_CERT_PATH=/secure/path/master.crt
163+
export ENCLAVED_EXPRESS_URL=https://enclaved.internal.example.com:3080
164+
export ENCLAVED_EXPRESS_CERT=/secure/path/enclaved.crt
165+
export MTLS_REQUEST_CERT=true
166+
export ALLOW_SELF_SIGNED=false
167+
npm start
168168
```
169169

170170
## Container Deployment with Podman

0 commit comments

Comments
 (0)