Skip to content

Commit 01bb7e9

Browse files
committed
Addressing #657
The installer has been improved to address #657
1 parent 1cecc8f commit 01bb7e9

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,35 @@ yarn global add @quobix/vacuum
3535

3636
## Install using curl
3737

38-
```
38+
```bash
3939
curl -fsSL https://quobix.com/scripts/install_vacuum.sh | sh
4040
```
4141

42+
### For CI/CD environments
43+
44+
To avoid GitHub API rate limiting in automated environments, set a GitHub token:
45+
46+
```bash
47+
# Using repository token (GitHub Actions)
48+
GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }} curl -fsSL https://quobix.com/scripts/install_vacuum.sh | sh
49+
50+
# Using personal access token
51+
GITHUB_TOKEN=your_github_token curl -fsSL https://quobix.com/scripts/install_vacuum.sh | sh
52+
```
53+
54+
#### GitHub Actions example
55+
56+
```yaml
57+
- name: Install vacuum
58+
env:
59+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Increases rate limit from 60 to 5000 requests/hour
60+
run: |
61+
curl -fsSL https://quobix.com/scripts/install_vacuum.sh | sh
62+
```
63+
64+
> **Note**: The GitHub token prevents intermittent installation failures in CI/CD environments caused by API rate limiting.
65+
> No additional permissions are required, the token only accesses public repository information.
66+
4267
## Install using [Docker](https://hub.docker.com/r/dshanley/vacuum)
4368
4469
The image is available at: https://hub.docker.com/r/dshanley/vacuum

0 commit comments

Comments
 (0)