[Summary view] [Print] [Text view]

   1  @title Configuring Accounts and Registration
   2  @group config
   3  
   4  Describes how to configure user access to Phabricator.
   5  
   6  = Overview =
   7  
   8  Phabricator supports a number of login systems. You can enable or disable these
   9  systems to configure who can register for and access your install, and how users
  10  with existing accounts can login.
  11  
  12  Methods of logging in are called **Authentication Providers**. For example,
  13  there is a "Username/Password" authentication provider available, which allows
  14  users to log in with a traditional username and password. Other providers
  15  support logging in with other credentials. For example:
  16  
  17    - **Username/Password:** Users use a username and password to log in or
  18      register.
  19    - **LDAP:** Users use LDAP credentials to log in or register.
  20    - **OAuth:** Users use accounts on a supported OAuth2 provider (like
  21      GitHub, Facebook, or Google) to log in or register.
  22    - **Other Providers:** More providers are available, and Phabricator
  23      can be extended with custom providers. See the "Auth" application for
  24      a list of available providers.
  25  
  26  By default, no providers are enabled. You must use the "Auth" application to
  27  add one or more providers after you complete the installation process.
  28  
  29  After you add a provider, you can link it to existing accounts (for example,
  30  associate an existing Phabricator account with a GitHub OAuth account) or users
  31  can use it to register new accounts (assuming you enable these options).
  32  
  33  = Recovering Administrator Accounts =
  34  
  35  If you accidentally lock yourself out of Phabricator, you can use the `bin/auth`
  36  script to recover access to an administrator account. To recover access, run:
  37  
  38    phabricator/ $ ./bin/auth recover <username>
  39  
  40  ...where `<username>` is the admin account username you want to recover access
  41  to. This will give you a link which will log you in as the specified
  42  administrative user.
  43  
  44  = Managing Accounts with the Web Console =
  45  
  46  To manage accounts from the web, login as an administrator account and go to
  47  `/people/` or click "People" on the homepage. Provided you're an admin,
  48  you'll see options to create or edit accounts.
  49  
  50  = Manually Creating New Accounts =
  51  
  52  There are two ways to manually create new accounts: via the web UI using
  53  the "People" application (this is easiest), or via the CLI using the
  54  `accountadmin` binary (this has a few more options).
  55  
  56  To use the CLI script, run:
  57  
  58    phabricator/ $ ./bin/accountadmin
  59  
  60  Some options (like setting passwords and changing certain account flags) are
  61  only available from the CLI. You can also use this script to make a user
  62  an administrator (if you accidentally remove your admin flag) or create an
  63  administrative account.
  64  
  65  = Next Steps =
  66  
  67  Continue by:
  68  
  69    - returning to the @{article:Configuration Guide}.