mirror of
https://github.com/discordeno/discordeno.git
synced 2026-06-02 00:40:07 +00:00
fa5cbd8ac9
* feat: initial fastify source * chore: remove extra stuff from git ignore * feat: rename to rest passthrough * feat: add swcrc file * feat: add Dockerfile * feat: more rest passthrough stuff * fix: add node_modules to Dockerfile * feat: misc passthrough changes * feat: add host to dockerfile * feat: add version tags and update names * feat: remove the old proxy application * feat: update registry package name * feat: re-add schedule * feat: cliff jumper initi * feat: update changelog * style: git cliff formatting * feat: update cliffjumper rc * feat: updating version for future cliff-jump run * revert: package name back * feat: add release script * feat: update dependabot configuration to manage rest passthrough app * chore: update actions/download-artifact version * feat: adding removal of the version in URL. * feat: making readme better
29 lines
1.1 KiB
Markdown
29 lines
1.1 KiB
Markdown
# Discordeno Rest Passthrough
|
|
|
|
## Prerequisites
|
|
|
|
Before running the app, make sure you have the following prerequisites installed:
|
|
|
|
- Docker: [Installation Guide](https://docs.docker.com/get-docker/)
|
|
- Discordeno: [GitHub Repository](https://github.com/discordeno/discordeno)
|
|
|
|
## Getting Started
|
|
|
|
1. `docker pull ghcr.io/discordeno/app-rest-passthrough:latest`
|
|
2. Create an environment file (you can use `-e` flags instead), example: `./my-env`
|
|
3. `docker run --detach --env-file ./my-env -p 8000:8000 --name dd-rest discordeno/app-rest-passthrough`
|
|
|
|
## Configuration
|
|
|
|
The app can be configured using environment variables. The following variables are available:
|
|
|
|
- `DISCORD_TOKEN`: The Discord bot token used for authentication.
|
|
- `HOST`: The host to bind the application to, for Docker it should be `0.0.0.0`. Defaults to `localhost`.
|
|
- `AUTHORIZATION_TOKEN`: The token that will be used to authorize the requests made. This can be anything generated by you.
|
|
|
|
You can set these variables either in a `.env` file or directly in your Docker command.
|
|
|
|
## License
|
|
|
|
This project is licensed under the [Apache 2.0 License](LICENSE).
|