Skip to content
This repository was archived by the owner on Dec 9, 2024. It is now read-only.

Commit 3b7c2a1

Browse files
Make setup instructions more generic (#742)
* Make setup instructions more generic * Fix list order
1 parent 1c1f76a commit 3b7c2a1

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

README.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,21 +22,22 @@
2222
sample data loaded.)
2323
1. Run `bin/rails server`
2424

25-
## Configuring local auth
25+
## Configuring auth
2626

2727
The Client ID and Secret should be used instead of `[REDACTED]`. Please don't
2828
save the Client ID or Client Secret anywhere online or locally other than in the
2929
`.env` file.
3030

31+
Client IDs and secrets are set up in the developer tooling for each service.
32+
3133
### Google
3234

3335
1. Go to [Google Cloud Console](https://console.cloud.google.com/)
3436
2. Go to "APIs & Services" -> "Credentials"
35-
3. Click on the AsyncGo OAuth client
36-
4. Copy the Client ID and Client Secret
37-
5. Open the `.env` file in the root of your local copy of the project
38-
6. Enter the Client ID as the `GOOGLE_CLIENT_ID`
39-
7. Enter the Client Secret as the `GOOGLE_CLIENT_SECRET`
37+
3. Copy or create the Client ID and Client Secret
38+
4. Open the `.env` file in the root of your local copy of the project
39+
5. Enter the Client ID as the `GOOGLE_CLIENT_ID`
40+
6. Enter the Client Secret as the `GOOGLE_CLIENT_SECRET`
4041

4142
Here's what a `.env` file looks like
4243

@@ -45,19 +46,15 @@ GOOGLE_CLIENT_ID=[REDACTED]
4546
GOOGLE_CLIENT_SECRET=[REDACTED]
4647
```
4748

48-
You need to be a member of the AsyncGo Google Cloud project to be able to access
49-
this.
50-
5149
### GitHub
5250

5351
1. Go to
5452
[GitHub Application](https://github.com/organizations/async-go/settings/applications)
55-
2. Click on the AsyncGo OAuth app
56-
3. Copy the Client ID
57-
4. Obtain the Client Secret
58-
5. Open the `.env` file in the root of your local copy of the project
59-
6. Enter the Client ID as the `GITHUB_CLIENT_ID`
60-
7. Enter the Client Secret as the `GITHUB_CLIENT_SECRET`
53+
2. Copy or create a Client ID
54+
3. Obtain the Client Secret
55+
4. Open the `.env` file in the root of your local copy of the project
56+
5. Enter the Client ID as the `GITHUB_CLIENT_ID`
57+
6. Enter the Client Secret as the `GITHUB_CLIENT_SECRET`
6158

6259
Here's what a `.env` file looks like
6360

@@ -73,7 +70,7 @@ GITHUB_CLIENT_SECRET=[REDACTED]
7370
## Blazer authentication
7471

7572
Blazer uses hard-coded user authentication. It checks if the user email ends
76-
with `@asyncgo.com`.
73+
with `@asyncgo.com`, but you can change this to meet your needs.
7774

7875
## Container builds
7976

0 commit comments

Comments
 (0)