Remo RechkemmerandGitHub
08186ea51c
* package ghr * add nix-based release scripts * refactor CI based on nix tests and release scripts * update stack version in circleci * update makefile * remove docker directory * add Docker Hub description * add README on docker
34 lines
1.6 KiB
Markdown
34 lines
1.6 KiB
Markdown
# PostgREST
|
|
|
|
[](https://gitter.im/begriffs/postgrest)
|
|
[](https://www.patreon.com/postgrest)
|
|
[](https://www.paypal.me/postgrest)
|
|
[](http://postgrest.org)
|
|
[](https://circleci.com/gh/PostgREST/postgrest/tree/master)
|
|
|
|
PostgREST serves a fully RESTful API from any existing PostgreSQL database. It
|
|
provides a cleaner, more standards-compliant, faster API than you are likely to
|
|
write from scratch.
|
|
|
|
# Usage
|
|
|
|
To learn how to use this container, see the [PostgREST Docker
|
|
documentation](https://postgrest.com/en/stable/install.html#docker).
|
|
|
|
You can configure the PostgREST image by setting the enviroment variables used
|
|
in the default `/etc/postgrest.conf` file or overriding that file. This is the
|
|
default configuration file:
|
|
|
|
```
|
|
$DEFAULT_CONFIG
|
|
```
|
|
|
|
# How this image is built
|
|
|
|
The image is built from scratch using
|
|
[Nix](https://nixos.org/nixpkgs/manual/#sec-pkgs-dockerTools) instead of a
|
|
`Dockerfile`, which yields a higly secure and optimized image. This is also why
|
|
no commands are listed in the image history. See the [PostgREST
|
|
respository](https://github.com/PostgREST/postgrest/tree/master/nix/docker) for
|
|
details on the build process and how to inspect the image.
|