Skip to content

Commit d1b22f0

Browse files
nlhkabumiketheman
andauthored
Improve clarity of docs re: authenticating in development env (#19161)
* Improve clarity of docs re: authenticating in development env * Update docs/dev/development/getting-started.md Co-authored-by: Mike Fiedler <miketheman@gmail.com> --------- Co-authored-by: Mike Fiedler <miketheman@gmail.com>
1 parent 1f3ab59 commit d1b22f0

File tree

1 file changed

+26
-35
lines changed

1 file changed

+26
-35
lines changed

docs/dev/development/getting-started.md

Lines changed: 26 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -279,47 +279,36 @@ use that port instead.
279279

280280
### Logging in to Warehouse
281281

282-
In the development environment, the password for every account has been set to
283-
the string `password`. You can log in as any account at
284-
http://localhost:80/account/login/.
282+
You can log into warehouse at http://localhost:80/account/login/.
285283

286-
To log in as an admin user, log in as `ewdurbin` with the password
287-
`password`. You can generate a TOTP value for logging in using:
288-
289-
```shell
290-
make totp
291-
```
292-
293-
These users also have recovery codes generated:
294-
295-
```text
296-
6ebc846aadf23e35
297-
7283821faf191a33
298-
68108e19d25e2eec
299-
4e6a18adb880fbc1
300-
f62627d29675725f
301-
4cda895a133b4cc8
302-
8678c6f0d9a1e6de
303-
edc6ce3800c0fc94 -- burned
304-
```
305-
306-
Some user accounts that you might want to try are:
284+
There are 4 accounts ready for you to use:
307285

308286
- `ewdurbin` - Superuser, 3 email addresses (one verified), has projects
309287
- `di` - Superuser, 2 email addresses (both verified), has projects
310288
- `dstufft` - Superuser, 2 email addresses (one verified), has projects
311289
- `miketheman` - Regular user, 1 email address (not verified), has a project
312290

313-
There are no Moderator accounts in the dev db, any Superuser can change a user
314-
to a moderator if needed.
291+
The password for every account has been set to the string `password`.
292+
293+
Using different accounts will allow you to see different parts of the site,
294+
and have slightly different experiences.
295+
296+
Note that there are no Moderator accounts in the dev db. Any Superuser can
297+
change a user to a moderator if needed.
315298

316-
All of these users have 2FA enabled via TOTP,
317-
using the same secret as `make totp`.
318-
You can scan the following QR code to add this TOTP secret to your TOTP authenticator:
299+
#### TOTP and Recovery Codes
300+
301+
To generate a TOTP token, run the following from your terminal:
302+
303+
```shell
304+
make totp
305+
```
306+
Alternatively, you can scan the QR code below to add these accounts to
307+
your authenticator app:
319308

320309
![TOTP QR Code](../assets/warehouse_admin_totp.png){ width="100" }
321310

322-
They also have the following Recovery Codes generated:
311+
The following static recovery codes are pre-generated for these users:
323312

324313
```text
325314
6ebc846aadf23e35
@@ -332,13 +321,15 @@ f62627d29675725f
332321
edc6ce3800c0fc94 -- burned
333322
```
334323

335-
Using different accounts will allow you to see different parts of the site,
336-
and have slightly different experiences.
324+
#### Email Verification
325+
326+
Auth verification emails are output to the console, or can be accessed
327+
from http://localhost:1080.
328+
329+
See [Testing Emails](email.md#testing-e-mails) for more information.
337330

338-
For example, using `miketheman` will require email verification.
339-
See [Testing Emails](email.md) for more information on how to see those emails.
340331

341-
### Logging in as users without 2FA
332+
#### Logging in as users without 2FA
342333

343334
For users that are not listed above,
344335
once logged in with the password `password`,

0 commit comments

Comments
 (0)