mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-09 16:13:31 +01:00
a49ed0a2d5
* refactor(proxy): rely on auth header instead * chore: typo * chore: language Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com> * chore: more language Co-authored-by: Aura Román <kyradiscord@gmail.com> * chore: more language nitpicks Co-authored-by: ckohen <chaikohen@gmail.com> * fix: unnecessary async --------- Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com> Co-authored-by: Aura Román <kyradiscord@gmail.com> Co-authored-by: ckohen <chaikohen@gmail.com>
85 lines
3.2 KiB
Markdown
85 lines
3.2 KiB
Markdown
<div align="center">
|
|
<br />
|
|
<p>
|
|
<a href="https://discord.js.org"><img src="https://discord.js.org/static/logo.svg" width="546" alt="discord.js" /></a>
|
|
</p>
|
|
<br />
|
|
<p>
|
|
<a href="https://discord.gg/djs"><img src="https://img.shields.io/discord/222078108977594368?color=5865F2&logo=discord&logoColor=white" alt="Discord server" /></a>
|
|
<a href="https://hub.docker.com/r/discordjs/proxy"><img src="https://img.shields.io/docker/v/discordjs/proxy.svg?sort=semver&maxAge=3600" alt="dockerhub version" /></a>
|
|
<a href="https://hub.docker.com/r/discordjs/proxy"><img src="https://img.shields.io/docker/pulls/discordjs/proxy.svg?maxAge=3600" alt="dockerhub pulls" /></a>
|
|
<a href="https://github.com/discordjs/discord.js/actions"><img src="https://github.com/discordjs/discord.js/actions/workflows/test.yml/badge.svg" alt="Build status" /></a>
|
|
</p>
|
|
<p>
|
|
<a href="https://vercel.com/?utm_source=discordjs&utm_campaign=oss"><img src="https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-vercel.svg" alt="Vercel" /></a>
|
|
</p>
|
|
</div>
|
|
|
|
## About
|
|
|
|
`@discordjs/proxy-container` - Lightweight HTTP proxy for Discord's API, brought to you as a container 📦
|
|
|
|
## Usage
|
|
|
|
Quickly spin up an instance:
|
|
|
|
`docker run -d --restart unless-stopped --name proxy -p 127.0.0.1:8080:8080 discordjs/proxy`
|
|
|
|
Use it:
|
|
|
|
```ts
|
|
import { Client } from 'discord.js';
|
|
|
|
const client = new Client({
|
|
// other options,
|
|
rest: {
|
|
api: 'http://localhost:8080/api',
|
|
},
|
|
});
|
|
```
|
|
|
|
Or with just `@discordjs/rest`:
|
|
|
|
```ts
|
|
import { REST } from '@discordjs/rest';
|
|
|
|
const rest = new REST({
|
|
api: 'http://localhost:8080/api',
|
|
});
|
|
```
|
|
|
|
**Do note that you should not use the same proxy with multiple bots. We cannot guarantee you won't hit rate limits.
|
|
Webhooks with tokens or other requests that don't include the Authorization header are okay, though!**
|
|
|
|
## Links
|
|
|
|
- [Website][website] ([source][website-source])
|
|
- [Documentation][documentation]
|
|
- [Guide][guide] ([source][guide-source])
|
|
Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
|
|
- [discord.js Discord server][discord]
|
|
- [Discord API Discord server][discord-api]
|
|
- [GitHub][source]
|
|
- [Related libraries][related-libs]
|
|
|
|
## Contributing
|
|
|
|
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
|
|
[documentation][documentation].
|
|
See [the contribution guide][contributing] if you'd like to submit a PR.
|
|
|
|
## Help
|
|
|
|
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
|
|
|
|
[website]: https://discord.js.org
|
|
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
|
|
[guide]: https://discordjs.guide/
|
|
[guide-source]: https://github.com/discordjs/guide
|
|
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html
|
|
[discord]: https://discord.gg/djs
|
|
[discord-api]: https://discord.gg/discord-api
|
|
[source]: https://github.com/discordjs/discord.js/tree/main/packages/proxy-container
|
|
[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries
|
|
[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md
|