Skip to content

Commit d391aad

Browse files
committed
docs: add more warning
1 parent 291e3ec commit d391aad

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,20 @@
33
> [!WARNING]
44
> This is a reverse-engineered proxy of GitHub Copilot API. It is not supported by GitHub, and may break unexpectedly. Use at your own risk.
55
6+
> [!WARNING]
7+
> **GitHub Security Notice:**
8+
> Excessive automated or scripted use of Copilot (including rapid or bulk requests, such as via automated tools) may trigger GitHub's abuse-detection systems.
9+
> You may receive a warning from GitHub Security, and further anomalous activity could result in temporary suspension of your Copilot access.
10+
>
11+
> GitHub prohibits use of their servers for excessive automated bulk activity or any activity that places undue burden on their infrastructure.
12+
>
13+
> Please review:
14+
>
15+
> - [GitHub Acceptable Use Policies](https://docs.github.com/site-policy/acceptable-use-policies/github-acceptable-use-policies#4-spam-and-inauthentic-activity-on-github)
16+
> - [GitHub Copilot Terms](https://docs.github.com/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)
17+
>
18+
> Use this proxy responsibly to avoid account restrictions.
19+
620
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/E1E519XS7W)
721

822
---
@@ -84,7 +98,7 @@ docker run -p 4141:4141 -e GH_TOKEN=your_token copilot-api start --verbose --por
8498
### Docker Compose Example
8599

86100
```yaml
87-
version: '3.8'
101+
version: "3.8"
88102
services:
89103
copilot-api:
90104
build: .
@@ -96,6 +110,7 @@ services:
96110
```
97111
98112
The Docker image includes:
113+
99114
- Multi-stage build for optimized image size
100115
- Non-root user for enhanced security
101116
- Health check for container monitoring
@@ -157,9 +172,9 @@ The following command line options are available for the `start` command:
157172

158173
### Debug Command Options
159174

160-
| Option | Description | Default | Alias |
161-
| ------ | ------------------------------ | ------- | ----- |
162-
| --json | Output debug info as JSON | false | none |
175+
| Option | Description | Default | Alias |
176+
| ------ | ------------------------- | ------- | ----- |
177+
| --json | Output debug info as JSON | false | none |
163178

164179
## API Endpoints
165180

0 commit comments

Comments
 (0)