Blame doc/first_steps.rst

Pierre-Yves Chibon 508cef
First Steps on pagure
Pierre-Yves Chibon 508cef
=====================
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
When coming to pagure for the first time there are a few things one should
Pierre-Yves Chibon 508cef
do or check to ensure all works as desired.
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
Login to pagure or create your account
Pierre-Yves Chibon 508cef
--------------------------------------
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
Pagure has its own user account system.
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon d89186
For instances of pagure such as the one at `pagure.io <https: pagure.io="">`_</https:>
Pierre-Yves Chibon 508cef
where the authentication is delegated to a third party (in the case of
Pierre-Yves Chibon 508cef
pagure.io, the Fedora Account System) via OpenID, the local user account
Pierre-Yves Chibon 508cef
is created upon login.
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
This means, you cannot be added to a group or a project before you login for
Pierre-Yves Chibon 508cef
the first time as the system will simply not know you.
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
If you run your own pagure instance which uses the local authentication
Pierre-Yves Chibon 508cef
system, then you will find on the login page an option to create a new
Pierre-Yves Chibon 508cef
account.
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
Upload your SSH key
Pierre-Yves Chibon 508cef
-------------------
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
Pagure uses gitolite to manage who has read/write access to which git
Pierre-Yves Chibon 508cef
repository via `ssh <https: en.wikipedia.org="" secure_shell="" wiki="">`_.</https:>
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
An ssh key is composed of two parts:
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
* a private key, which you must keep to yourself and never share with anyone.
Pierre-Yves Chibon 508cef
* a public key, which is public and therefore can be shared with anyone.
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
If you have never generated a ssh key, you can do so by running:
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
::
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
    ssh-keygen
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon d89186
or alternatively on GNOME using the application ``seahorse``.
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
This will create two files in ``~/.ssh/`` (``~`` is the symbol for your home
Pierre-Yves Chibon 508cef
folder).
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
These two files will be named (for example) ``id_rsa`` and ``id_rsa.pub``.
Pierre-Yves Chibon 508cef
The first one is the private key that must never be shared. The second is
Pierre-Yves Chibon 508cef
the public key that can be uploaded on pagure to give you ssh access.
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
To upload your public key onto pagure, login and click on the user icon on
Pierre-Yves Chibon 508cef
the top right corner, there, select ``My settings``.
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
.. image:: _static/pagure_my_settings.png
Pierre-Yves Chibon 508cef
        :target: _static/pagure_my_settings.png
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
Configure the default email address
Pierre-Yves Chibon 508cef
-----------------------------------
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
If the pagure instance you use is using local user authentication, then when
Pierre-Yves Chibon 508cef
you created your account you could choose whichever email address you prefer
Pierre-Yves Chibon 508cef
to use, but in the case (like pagure.io) where the pagure instance relies
Pierre-Yves Chibon 508cef
on an external authentication service, the email address provided by this
Pierre-Yves Chibon 508cef
service may be different from the one you prefer.
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
Your settings' page (cf the image above for how to access to the page) allow
Pierre-Yves Chibon 508cef
you to add multiple email address and set one as default.
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
Your default email address is the address that will be used to send you
Pierre-Yves Chibon 508cef
notifications and also as the email address in the git commit if you merge
Pierre-Yves Chibon 508cef
a pull-request with a merge commit.
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
For online editing, when doing the commit, you will be presented with the
Pierre-Yves Chibon 508cef
list of valid email addresses associated with your account and you will be
Pierre-Yves Chibon 508cef
able to choose which one you wish to use.
Pierre-Yves Chibon 508cef
Pierre-Yves Chibon 508cef
.. note:: All email address will need to be confirmed to be activated, this
Pierre-Yves Chibon 508cef
          is done via a link sent by email to the address. If you do not
Pierre-Yves Chibon 508cef
          receive this link, don't forget to check your spam folder!