gem-hunterCreate a PostgreSQL database with a REST API, exposed to the internet securely with Cloudflare Tunnel
An example docker-compose setup for configuring a PostgreSQL database and the associated PostgREST endpoint, which is exposed to the internet using cloudflared.
You can start up all the services in this project by running docker-compose up:
$ 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.
You can generate some example data by running the create-example-data.sql script inside of your running docker container:
$ 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.
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:
$ 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:
$ 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 to secure your API:
$ 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"}]
If you'd like to create a permanent cloudflared tunnel at a custom endpoint, you can configure your tunnel. 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.
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.