Skip to content

Updated documentation #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 14, 2024
Merged

Updated documentation #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions listing/usage-information.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,11 @@
</li>
</ul>

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

<p><strong>Database</strong>: The stack assumes that the persistence is handled by a database and this section lets you
configure that database. You can either choose an existing database by selecting the database or create a new one.</p>
Expand Down
Binary file modified screenshots/7_Vault.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion usage_instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,10 @@ The stack supports different kinds of deployments: *source code* deployment, jav

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

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.

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.
To use an existing token:
- **User's authentication token:** provide the user's authentication token

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.

Expand Down