Skip to content

Commit cf9b147

Browse files
docs: document the token as an environment variable
The compose file now reads it from the environment, so the instructions to write it into a file left contributors with an unauthenticated, and therefore rate-limited, fetch of the contributors list. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent 15506ec commit cf9b147

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ You need to use a valid github token to retrieve the list of contributors.
1818
2. Select scopes `public_repo`, `read:org` and `read:user`, generate the token and copy it.
1919
3. If you use "pnpm dev" on the folder pwa to launch the project, add a new `.env.local` file on the root of pwa folder, and set your token as an environment variable named `GITHUB_KEY`.
2020

21-
If you use docker, create a file "secret_github_key" at the root of the project with your token inside:
21+
If you use docker, export your token as a `GITHUB_KEY` environment variable, which the compose file reads to build the images:
2222

2323
```console
24-
# Create the secret_github_key file
25-
echo "YOUR_GITHUB_TOKEN" > secret_github_key
24+
# Export the token for the current shell
25+
export GITHUB_KEY=YOUR_GITHUB_TOKEN
2626
```
2727

2828
> **❗Core team badges restriction**: You need to be a member of API Platform organization to retrieve API Platform teams. You can still locally launch the project, but the badges of the core team members will not appear.
@@ -38,8 +38,8 @@ git clone https://github.com/api-platform/website.git
3838
# Change directory
3939
cd website
4040

41-
# Create the github_key file
42-
echo YOUR_GITHUB_TOKEN > secret_github_key
41+
# Export the GitHub token
42+
export GITHUB_KEY=YOUR_GITHUB_TOKEN
4343

4444
# Install and run the project locally
4545
docker compose up -d

0 commit comments

Comments
 (0)