https://github.com/cloudflare/postgres-postgrest-cloudflared-example
Create a PostgreSQL database with a REST API, exposed to the internet securely with Cloudflare Tunnel
https://github.com/cloudflare/postgres-postgrest-cloudflared-example
Last synced: 3 months ago
JSON representation
Create a PostgreSQL database with a REST API, exposed to the internet securely with Cloudflare Tunnel
- Host: GitHub
- URL: https://github.com/cloudflare/postgres-postgrest-cloudflared-example
- Owner: cloudflare
- License: mit
- Created: 2021-06-14T17:40:47.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-27T17:09:44.000Z (10 months ago)
- Last Synced: 2025-04-02T14:58:15.848Z (3 months ago)
- Size: 7.81 KB
- Stars: 63
- Watchers: 3
- Forks: 13
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Postgrest Docker example
An example `docker-compose` setup for configuring a PostgreSQL database and the associated PostgREST endpoint, which is exposed to the internet using `cloudflared`.
## Initialize the containers
You can start up all the services in this project by running `docker-compose up`:
```sh
$ docker-compose up -d
```
_Note: depending on how your Docker installation is set up, you may need to preface the above command (and any other `docker-compose` examples) with `sudo`._
## Example data
You can generate some example data by running the `create-example-data.sql` script inside of your running docker container:
```sh
$ docker-compose exec postgres psql -U user -d db -f /scripts/create-example-data.sql
```
This will create a `users` table and a single user with the name `Kristian`.
## Making requests
A `cloudflared` tunnel will be generated when you run `docker-compose` up, such as `https://honolulu-devices-update-drink.trycloudflare.com`. You can find the currently active tunnel URL by looking through the `docker-compose` logs:
```sh
$ docker-compose logs cloudflared | grep trycloudflare
cloudflared_1 | INFO[2021-06-14T17:26:05Z] | https://honolulu-devices-update-drink.trycloudflare.com
```
This tunnel allows access to the PostgREST endpoint. You can make a few example requests to see data correctly returned from PostgreSQL to PostgREST, and then to your terminal:
```sh
$ curl https://honolulu-devices-update-drink.trycloudflare.com/users
[{"id":1,"name":"Kristian"}]
$ curl https://honolulu-devices-update-drink.trycloudflare.com/users?id=eq.1
[{"id":1,"name":"Kristian"}]
$ curl https://honolulu-devices-update-drink.trycloudflare.com/users?id=eq.2
[]
```
You can also create records using the PostgREST API, though you should go through the [PostgREST tutorial on user authentication](https://postgrest.org/en/stable/tut1.html) to secure your API:
```sh
$ curl https://honolulu-devices-update-drink.trycloudflare.com/users \
-X POST \
-H "Content-type: application/json" \
-d '{"name": "Dog"}'
$ curl https://honolulu-devices-update-drink.trycloudflare.com/users?name=eq.Dog
[{"id":2, "name":"Dog"}]
```
## Tunnel configuration
If you'd like to create a permanent `cloudflared` tunnel at a custom endpoint, you can [configure your tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/configuration/config). The provided `cloudflared` directory will be exposed to the Docker container, so you can add `config.yml` and any relevant JSON/certificate files to authenticate and configure your tunnel.
## Thanks
This repository and the (soon-to-come) tutorial for integrating with this on Cloudflare Workers was inspired by @eidam's great tutorial and sample codebase for running an authenticated and secure PostgreSQL, PostgREST, and `cloudflared` integration on Google Cloud, [available here](https://github.com/cloudflare/argo-tunnel-examples/tree/master/terraform-zerotrust-postgrest-worker).