Skip to content

Commit 416478a

Browse files
committed
lockdown doc
1 parent 607a330 commit 416478a

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

public/doc.html

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,20 @@ <h2 class="type_subhead">DELETE /api/:name</h2>
9090
</ul>
9191
</figure>
9292

93+
<h2 class="type_subhead">Lockdown mode</h2>
94+
<p>To make your auto-complete indexes read-only, simply set an environment variable "LOCKDOWN" to be "true".
95+
This will leave only the "GET /api/:name" endpoint working e.g.</p>
96+
<figure class="guide-example theme_light bg_light-tint">
97+
<p class="type_copy">LOCKDOWN=true node app.js</p>
98+
</figure>
99+
<p>or in Bluemix:</p>
100+
<ul>
101+
<li>Go to "Environment Variables"</li>
102+
<li>Open the "User-Defined" tab</li>
103+
<li>Click "Add" and add a "LOCKDOWN" variable with a value of "true"</li>
104+
<li>Click "Save" and after a restart, your autocomplete service will be locked down</li>
105+
</ul>
106+
93107
</section>
94108
<!-- end API -->
95109

0 commit comments

Comments
 (0)