Skip to content

Commit ace5d0e

Browse files
update manual installation instructions
1 parent 9b3dfe7 commit ace5d0e

File tree

1 file changed

+46
-25
lines changed

1 file changed

+46
-25
lines changed

README.md

Lines changed: 46 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,45 @@ MyConnectWebhook demonstrates the following:
3434
* **authorization_server** - https://account-d.docusign.com for the development environment
3535
* **aud** - `account-d.docusign.com` for the development environment
3636

37+
## Installation steps
38+
39+
### Clone project
40+
Clone project into folder `./sample-app-myconnectwebhook-ruby`
41+
```
42+
git clone [email protected]:docusign/sample-app-myconnectwebhook-ruby.git
43+
```
44+
### Run command to move to project folder
45+
```
46+
cd sample-app-myconnectwebhook-ruby
47+
```
3748

38-
## Setup your custom DocuSign Connect configuration
49+
### Create appsettings.yml file
50+
Copy `appsettings.example.yml` and fill it in with your settings taken from DocuSign Developer Account.
51+
```
52+
cp config/appsettings.example.yml config/appsettings.yml
53+
```
3954

40-
### Using a ruby script
55+
### Create a webhook listener (for local development)
56+
Create a secure URL for your app to receive webhook notifications using ngrok.
57+
58+
#### Install Ngrok Tunnel (for local development)
59+
```
60+
https://ngrok.com/download
61+
```
62+
#### Run Ngrok Tunnel (for local development)
63+
```
64+
ngrok http 3000
65+
```
66+
#### Add your secure ngrok URL as an authorized host
67+
* open `config/environments/development.rb`
68+
* Change {NGROK_HOST} to the URL generated by ngrok in the previous step
69+
```
70+
config.hosts << "xxx-xx-xxx-xxx-xx.ngrok.io"
71+
```
72+
73+
### Setup your custom DocuSign Connect configuration
74+
75+
#### Using a ruby script
4176
The ruby script included with this project sets up a custom Connect configuration with the same settings that the hosted app uses at https://myconnectwebhook.sampleapps.docusign.com. You'll need to provide a name for your new custom connect configuration as well as the URL to publish which, if running locally using ngrok, should follow the format `https://{YOUR_NGROK_HOST}.ngrok.io/api/docusign/trigger/do_process.json`.
4277

4378
* Navigate to the root folder of the app
@@ -51,7 +86,7 @@ The ruby script included with this project sets up a custom Connect configuratio
5186
* Provide the name and URL to publish for your connect configuration when prompted.
5287
* Check https://admindemo.docusign.com/connect to view or edit your new custom Connect configuration!
5388

54-
### Using the DocuSign UI
89+
#### Using the DocuSign UI
5590
* Visit https://admindemo.docusign.com/authenticate?goTo=connect
5691
* Select "ADD CONFIGURATION" --> "Custom"
5792
* Add a name for your custom Connect configuration
@@ -81,11 +116,11 @@ The ruby script included with this project sets up a custom Connect configuratio
81116
* Select "Enable Mutual TLS"
82117
* "SAVE CONFIGURATION"
83118

84-
## Installation steps
119+
## Running the app
85120

86121
**NOTE:** The first time you run the app with a new client id, you must grant consent for the application to perform actions on behalf of the user. Fill in your integration key and redirect url to the following consent url template and visit `https://account-d.docusign.com/oauth/auth?response_type=code&scope=signature+impersonation+click.manage+click.send&client_id=#{jwt_integration_key}&redirect_uri=#{redirect_uri}` to grant consent.
87122

88-
### Running app using docker compose
123+
### Running the app using docker compose
89124
To build app:
90125
```
91126
docker compose build
@@ -130,15 +165,14 @@ brew install redis
130165
brew services start redis
131166
redis-server
132167
```
133-
#### Clone project
134-
Clone project into folder `./sample-app-myconnectwebhook-ruby`
135-
```
136-
git clone [email protected]:docusign/sample-app-myconnectwebhook-ruby.git
168+
169+
#### Install postgresql
170+
On Mac
137171
```
138-
#### Run command to move project folder
139-
```
140-
cd sample-app-myconnectwebhook-ruby
172+
brew install postgresql@14
173+
brew services start postgresql
141174
```
175+
142176
rvm recognize ruby version and create new gemset
143177
#### Install bundler
144178
```
@@ -161,19 +195,6 @@ Use NVM https://github.com/nvm-sh/nvm and Node.js version 16+.
161195
```
162196
yarn install
163197
```
164-
#### Copy appsettings.yml
165-
Copy `appsettings.yml` and fill it in with your settings taken from DocuSign Developer Account.
166-
```
167-
cp config/appsettings.example.yml config/appsettings.yml
168-
```
169-
#### Install Ngrok Tunnel (for local development)
170-
```
171-
https://ngrok.com/download
172-
```
173-
#### Run Ngrok Tunnel (for local development)
174-
```
175-
ngrok http 3000
176-
```
177198

178199
#### Running MyConnectWebhook Sample App
179200
```

0 commit comments

Comments
 (0)