Mirrors/pokeapi
2
0
Fork 0
mirror of https://github.com/PokeAPI/pokeapi synced 2024-11-22 19:33:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #620 from PokeAPI/docker-images

Browse source
This commit is contained in:
Alessandro Pezzè 2021-05-17 09:16:53 +02:00 committed by GitHub
commit 159c0231ed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 38 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
Resources/docker/app/README.md Normal file
View file

@ -0,0 +1,35 @@
# 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/)
![logo](https://raw.githubusercontent.com/PokeAPI/media/master/logo/pokeapi_256.png)
## 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.

7
config/docker-compose.py
View file

@ -8,16 +8,15 @@ DATABASES = {
"NAME": os.environ.get("POSTGRES_DB", "pokeapi"), "NAME": os.environ.get("POSTGRES_DB", "pokeapi"),
"USER": os.environ.get("POSTGRES_USER", "ash"), "USER": os.environ.get("POSTGRES_USER", "ash"),
"PASSWORD": os.environ.get("POSTGRES_PASSWORD", "pokemon"), "PASSWORD": os.environ.get("POSTGRES_PASSWORD", "pokemon"),
"HOST": "db", "HOST": os.environ.get("POSTGRES_HOST", "db"),
"PORT": 5432, "PORT": os.environ.get("POSTGRES_PORT", 5432),
} }
} }
CACHES = { CACHES = {
"default": { "default": {
"BACKEND": "django_redis.cache.RedisCache", "BACKEND": "django_redis.cache.RedisCache",
"LOCATION": "redis://cache:6379/1", "LOCATION": os.environ.get("REDIS_CONNECTION_STRING", "redis://cache:6379/1"),
"OPTIONS": { "OPTIONS": {
"CLIENT_CLASS": "django_redis.client.DefaultClient", "CLIENT_CLASS": "django_redis.client.DefaultClient",
}, },