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
+7-2Lines changed: 7 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,11 +92,14 @@ For a list of code examples that use the Admin API, see the [How-to guides overv
92
92
93
93
1.[Ruby version 2.7.2](https://www.ruby-lang.org/en/downloads/) or later
94
94
1. Update the Gemfile to use later versions of Ruby.
95
+
1. Update the **.ruby-version** to use your preferred version of Ruby. Ruby version managers may automatically switch your Ruby version to what is specified in .ruby-version file.
95
96
1. Windows x64 only:
96
97
1. Ensure that your Ruby folder is appended with **-x64**, e.g. **Ruby27-x64**
97
98
2. Install Curl for Ruby: [Download libcurl.dll](https://curl.haxx.se/windows/)
98
99
Save **libcurl-x64.dll** as **libcurl.dll**
99
100
Place **libcurl.dll** in your Ruby folder, e.g. **C:\Ruby27-x64\bin**
101
+
3.**Git Bash is not recommended**: it can cause issues with interactive input/output, signal handling, and path/quoting differences.
102
+
Use WSL or the VS Code integrated Bash terminal instead
100
103
101
104
102
105
### Installation steps
@@ -105,6 +108,7 @@ For a list of code examples that use the Admin API, see the [How-to guides overv
105
108
1. Extract the Quickstart ZIP file, or download or clone the code-examples-ruby repository.
106
109
1. In your command-line environment, switch to the folder:
107
110
`cd <Quickstart folder>` or `cd code-examples-ruby`
111
+
1. Adjust Ruby version in **Gemfile** and **.ruby-version**
108
112
1. To install dependencies, run: `bundler install`
109
113
1. To configure the launcher for [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) authentication, create a copy of the file config/appsettings.example.yml and save the copy as config/appsettings.yml.
110
114
1. Add your integration key. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **Apps and Integration Keys**, choose the app to use, then select **Actions** > **Edit**. Under **General Info**, copy the **Integration Key** GUID and save it in appsettings.yml as your `integration_key`.
@@ -123,6 +127,7 @@ Also, in order to select JSON Web Token authentication in the launcher, in confi
123
127
1. Extract the Quickstart ZIP file or download or clone the code-examples-ruby repository.
124
128
1. In your command-line environment, switch to the folder:
125
129
`cd <Quickstart folder>` or `cd code-examples-ruby`
130
+
1. Adjust Ruby version in **Gemfile** and **.ruby-version**
126
131
1. Install the dependencies: `bundler install`
127
132
1. To configure the launcher for [JWT Grant](https://developers.docusign.com/platform/auth/jwt/) authentication, create a copy of the file config/appsettings.example.yml and save the copy as config/appsettings.yml.
128
133
1. Add your User ID. On the [Apps and Keys](https://admindemo.docusign.com/authenticate?goTo=apiIntegratorKey) page, under **My Account Information**, copy the **User ID** GUID and save it in appsettings.yml as your `impersonated_user_guid`.
@@ -141,7 +146,7 @@ Also, in order to select JSON Web Token authentication in the launcher, in confi
141
146
See [Docusign Quickstart overview](https://developers.docusign.com/docs/esign-rest-api/quickstart/overview/) on the Docusign Developer Center for more information on how to run the JWT grant remote signing project and the Authorization Code Grant embedded signing project.
142
147
143
148
### Authorization Code Grant embedded signing example:
0 commit comments