mirror of
https://github.com/PokeAPI/pokeapi
synced 2024-11-29 23:00:23 +00:00
36 lines
1.4 KiB
Markdown
36 lines
1.4 KiB
Markdown
|
# Quick reference
|
||
|
|
|
||
|
|
- **Maintained by**:
|
||
|
|
[the PokeAPI Contributors](https://github.com/PokeAPI/pokeapi/graphs/contributors)
|
||
|
|
|
||
|
|
- **Where to get help**:
|
||
|
|
[PokeAPI Slack](http://pokeapi.slack.com/).
|
||
|
|
|
||
|
|
- **Where to file issues**:
|
||
|
|
[https://github.com/PokeAPI/pokeapi/issues](https://github.com/PokeAPI/pokeapi/issues)
|
||
|
|
|
||
|
|
- **Source of this description**:
|
||
|
|
[pokeapi repo's `Resources/docker/app/` directory](https://github.com/PokeAPI/pokeapi/blob/master/Resources/docker/app/README.md)
|
||
|
|
|
||
|
|
## Supported tags and respective `Dockerfile` links
|
||
|
|
|
||
|
|
- [`latest`](https://github.com/PokeAPI/pokeapi/blob/master/Resources/docker/app/Dockerfile)
|
||
|
|
|
||
|
|
## What is PokeAPI?
|
||
|
|
|
||
|
|
PokeAPI is a full RESTful API linked to an extensive database detailing everything about the Pokémon main game series.
|
||
|
|
|
||
|
|
> [pokeapi.co](https://pokeapi.co/)
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## How to use this image
|
||
|
|
|
||
|
|
This container connects to a Postgres database via the environment variables `POSTGRES_DB`, `POSTGRES_USER`, `POSTGRES_PASSWORD`, `POSTGRES_HOST`, `POSTGRES_PORT`.
|
||
|
|
|
||
|
|
The container connects to a Redis cache via the environment variable `REDIS_CONNECTION_STRING`.
|
||
|
|
|
||
|
|
### Run the container using Compose
|
||
|
|
|
||
|
|
The container exposes port `80`. It's recommended to use the provided [docker-compose.yml](https://github.com/PokeAPI/pokeapi/blob/master/docker-compose.yml) to start a container from this image.
|