1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-11-29 10:12:41 +01:00

Update documentation to reflect bin/auth changes

Summary: See https://secure.phabricator.com/D18901#249481. Update the docs and a warning string to reflect the new reality that `bin/auth recover` is now able to recover any account, not just administrators.

Test Plan: Mk 1 eyeball

Reviewers: epriestley

Reviewed By: epriestley

Subscribers: Korvin

Differential Revision: https://secure.phabricator.com/D20007
This commit is contained in:
Austin McKinley 2019-01-21 11:56:56 -08:00
parent 881d79c1ea
commit 6138d5885d
2 changed files with 10 additions and 12 deletions

View file

@ -88,7 +88,7 @@ final class PhabricatorAuthStartController
'This Phabricator install is not configured with any enabled '. 'This Phabricator install is not configured with any enabled '.
'authentication providers which can be used to log in. If you '. 'authentication providers which can be used to log in. If you '.
'have accidentally locked yourself out by disabling all providers, '. 'have accidentally locked yourself out by disabling all providers, '.
'you can use `%s` to recover access to an administrative account.', 'you can use `%s` to recover access to an account.',
'phabricator/bin/auth recover <username>')); 'phabricator/bin/auth recover <username>'));
} }

View file

@ -14,8 +14,6 @@ there is a "Username/Password" authentication provider available, which allows
users to log in with a traditional username and password. Other providers users to log in with a traditional username and password. Other providers
support logging in with other credentials. For example: support logging in with other credentials. For example:
- **Username/Password:** Users use a username and password to log in or
register.
- **LDAP:** Users use LDAP credentials to log in or register. - **LDAP:** Users use LDAP credentials to log in or register.
- **OAuth:** Users use accounts on a supported OAuth2 provider (like - **OAuth:** Users use accounts on a supported OAuth2 provider (like
GitHub, Facebook, or Google) to log in or register. GitHub, Facebook, or Google) to log in or register.
@ -30,16 +28,16 @@ After you add a provider, you can link it to existing accounts (for example,
associate an existing Phabricator account with a GitHub OAuth account) or users associate an existing Phabricator account with a GitHub OAuth account) or users
can use it to register new accounts (assuming you enable these options). can use it to register new accounts (assuming you enable these options).
= Recovering Administrator Accounts = = Recovering Inaccessible Accounts =
If you accidentally lock yourself out of Phabricator, you can use the `bin/auth` If you accidentally lock yourself out of Phabricator (for example, by disabling
script to recover access to an administrator account. To recover access, run: all authentication providers), you can use the `bin/auth`
script to recover access to an account. To recover access, run:
phabricator/ $ ./bin/auth recover <username> phabricator/ $ ./bin/auth recover <username>
...where `<username>` is the admin account username you want to recover access ...where `<username>` is the account username you want to recover access
to. This will give you a link which will log you in as the specified to. This will generate a link which will log you in as the specified user.
administrative user.
= Managing Accounts with the Web Console = = Managing Accounts with the Web Console =
@ -57,9 +55,9 @@ To use the CLI script, run:
phabricator/ $ ./bin/accountadmin phabricator/ $ ./bin/accountadmin
Some options (like setting passwords and changing certain account flags) are Some options (like changing certain account flags) are only available from
only available from the CLI. You can also use this script to make a user the CLI. You can also use this script to make a user
an administrator (if you accidentally remove your admin flag) or create an an administrator (if you accidentally remove your admin flag) or to create an
administrative account. administrative account.
= Next Steps = = Next Steps =