Skip to content
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.

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

Manage Users Documentation added #5980

Closed
wants to merge 17 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
54 changes: 54 additions & 0 deletions content/doc/book/managing/users.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,57 @@ endif::[]

= Manage Users

== Setting up User Accounts -

As soon as we set up Jenkins in our local computers and go to the required TCP port we set during installation, we get to see the following page where we can enter our details as a first time user

image::jenkins.io/content/doc/book/resources/managinguserimg/create-first-admin-user.png["Create First Admin User", role=center]

== Manage Jenkins -

Once the creation of the user account is done, after filling in the user details, we are all set to use Jenkins.
After signing into Jenkins, there is a navigation pane on the left side of the dashboard with options including the ones shown below.
From here, there are further options within different areas.
From there we will navigate to the *Security* section where we can find the *Manage Users* option.
This option can be utilized to create, delete, or modify details of users that have signed into Jenkins.

image::jenkins.io/content/doc/book/resources/managinguserimg/security-section-options.png["Security Section Options", role=center]

== Configure User Details -

After clicking on that option, we can see a list of users and we need to click on the
user id whose details need to be altered. Now on the left side again we see a "Configure"
option on the left panel.

image::jenkins.io/content/doc/book/resources/managinguserimg/configure-user-details.png["Configure User Details", role=center]

This section provides multiple options to add/update user details including:

Full Name :: In this option you can update the full name for your Jenkins account.
It is preferred to put your real name in this field for easier identification.

- Description - This option allows you to put up a short introduction of yourself which will be
displayed on user top page so that visitors can get insights about us.

- API Token - All registered tokens for the user are displayed here.

- Credentials -

- E-mail - Users can check their verified email address used for their Jenkins profile.
You can also use the email address while logging into your Jenkins account.

- Views -

- Notification URL -

- Password - You can use password along with the email address to login to your Jenkins account.
Initially it is set to the default temporary password provided to you by Jenkins,
but you can always change it according to your own choice.

- SSH Public Keys - Pairs of public and private SSH Keys are displayed in this section.

- Session Termination option - You can terminate the current session to start a new one
later with this option.

- Time Zone - You can choose your nearest timezone to operate your Jenkins account or you can
also go with the Default time zone that is already set from beginning.
1 change: 1 addition & 0 deletions content/doc/book/resources/managingusers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.