diff --git a/static/partials/guide.html b/static/partials/guide.html index e3af803a6..49124aa1d 100644 --- a/static/partials/guide.html +++ b/static/partials/guide.html @@ -50,11 +50,32 @@ Email: my@email.com</pre> </div> <br> + <h3>Using robot accounts <span class="label label-info">Requires Admin Access</span></h3> + <div class="container"> + <div class="description-overview"> + There are many circumstances where permissions for repositories need to be shared across those repositories (continuous integration, etc). + To support this case, Quay allows the use of <b>robot accounts</b> which can be created in the user/organization's admin view and can be + shared by multiple repositories that are owned by that user or organization. + </div> + + <ul class="description-list"> + <li>Robot accounts can be managed in the user or organization admin's interface + <li><b>Adding a robot account:</b> Click "Create Robot Account" and enter a name for the account. The username will become <b>namespace+accountname</b> where "namespace" is the name of the user or organiaztion. + <li><b>Setting permissions:</b> Permissions can be granted to a robot account in a repository by adding that account like any other user or team. + <li><b>Deleting a robot account:</b> A robot account can be deleted by clicking the <b>X</b> and then clicking <b>Delete</b> + <li><b>Using a robot account:</b> To use the robot account, the following credentials can be used: + <dl class="dl-horizontal"> + <dt>Username</dt><dd>namespace+accountname (Example: mycompany+deploy)</dd> + <dt>Password</dt><dd>(token value can be found by clicking on the robot account in the admin panel)</dd> + <dt>Email</dt><dd>This value is ignored, any value may be used.</dd> + </dl> + </ul> + </div> + <h3>Using access tokens in place of users <span class="label label-info">Requires Admin Access</span></h3> <div class="container"> <div class="description-overview"> - There are many circumstances where it makes sense to <b>not</b> use a user's username and password (deployment scripts, etc). - To support this case, Quay allows the use of <b>access tokens</b> which can be created on a repository and have read and/or write + For per-repository token authentication, Quay allows the use of <b>access tokens</b> which can be created on a repository and have read and/or write permissions, without any passwords. </div>