Skip to content

Commit 7dc3f2a

Browse files
authored
Updated documentation (#32)
1 parent c5377fb commit 7dc3f2a

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

listing/usage-information.html

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,11 @@
5151
</li>
5252
</ul>
5353

54-
<p><strong>Stack authentication</strong>: the stack uses an API key to connect to the repository. A&nbsp;Vault is used
55-
to store sensitive information such as passwords.&nbsp;The stack can either use an existing vault or create a new
56-
one.&nbsp;To use an existing key vault, the stack will let you select the existing vault and key (AES). To create a
57-
new vault you must provide the&nbsp;user-friendly name of the vault to create.</p>
54+
<p><strong>Stack authentication</strong>: a Vault is used to store sensitive information such as authentication tokens
55+
and passwords. The stack can either use an existing vault or create a new one. To use an existing key vault, the stack
56+
will let you select the existing vault and key (AES). To create a new vault you must provide a user-friendly name of
57+
the vault to create. An <strong>authentication token</strong> is to authenticate the user when accessing the code
58+
repository, it can either be provided or created by the stack.</p>
5859

5960
<p><strong>Database</strong>: The stack assumes that the persistence is handled by a database and this section lets you
6061
configure that database. You can either choose an existing database by selecting the database or create a new one.</p>

screenshots/7_Vault.png

-3.89 KB
Loading

usage_instructions.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,10 @@ The stack supports different kinds of deployments: *source code* deployment, jav
4242

4343
![](./screenshots/7_Vault.png)
4444

45+
An **authentication token** is used by the stack to authenticate the user when connecting to the code repository. This token can either be provided or created by the stack. **Note** that there is a limit on the maximum number of authentication tokens a user can have and that once the token is generated it will not be displayed again.
4546

46-
An **API key** is used to authenticate the user when connecting to the code repository. The stack can either create a new API key or use an existing API key if the **private key** is provided.
47+
To use an existing token:
48+
- **User's authentication token:** provide the user's authentication token
4749

4850
A **Vault** is used to store sensitive information such as authentication tokens and passwords. The stack can either use an existing vault (which can be in a different compartment) or create a new one.
4951

0 commit comments

Comments
 (0)