Merge pull request supabase#3 from supabase/chore/self-hosting

more docs

Author: kiwicopple

.env.example

@@ -0,0 +1,4 @@
+PASSWORD_PROTECTED=true
+SUPABASE_PROJECT_REF=
+SUPABASE_SERVICE_ROLE_KEY=
+GRAFANA_PASSWORD=

.gitignore

@@ -1 +1,2 @@
-.vscode/
+.vscode/
+.env

Dockerfile

@@ -15,6 +15,7 @@ ENV GF_PATHS_DATA=/data/grafana/data \
     GF_AUTH_PROXY_ENABLED="true" \
     GF_USERS_ALLOW_SIGN_UP=false \
     GF_SERVER_HTTP_ADDR="0.0.0.0" \
+    GF_SERVER_HTTP_PORT=8080 \
     GF_DASHBOARDS_DEFAULT_HOME_DASHBOARD_PATH="/var/lib/grafana/dashboards/dashboard.json"
 
 COPY entrypoint.sh /entrypoint.sh
@@ -31,4 +32,6 @@ COPY grafana/dashboard.json /var/lib/grafana/dashboards/dashboard.json
 
 COPY supervisord.conf /etc/supervisor/conf.d/supervisord.conf
 
+EXPOSE 8080
+
 ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -1,16 +1,50 @@
-## Instructions
-
-1. Make sure you have the following details available:
-   1. Your Supabase project ref
-   2. Your project's service role key, which can be found [here](https://app.supabase.com/project/sngruicxdhrqfujqijal/settings/api)
-2. Replace the following values in the `fly.toml` file:
-   1. `my_supabase_project_ref` with your Supabase project ref
-   2. `my_service_role_key` with your project's service role key
-   3. If you want your Grafana instance to be password protected:
-      1. Set `PASSWORD_PROTECTED` to `true`
-      2. Change `GRAFANA_PASSWORD` to your desired values
-      3. Login using `admin` and your set password
-3. Make sure you have the [Fly CLI](https://fly.io/docs/getting-started/installing-flyctl/) installed
-4. Create a Fly.io account and login using the CLI
-5. Run `flyctl launch` to deploy the app to Fly, ensuring that you give your app a unique name
-6. After a successful deployment, your app will be available at `https://<your-app-name>.fly.dev`:
+# `supabase-grafana`
+
+Observability for your Supabase project, using Prometheus/Grafana, collecting [~200 metrics](./docs/metrics.md):
+
+![./docs/supabase-grafana-prometheus.png](./docs/supabase-grafana-prometheus.png)
+
+## Getting started
+
+To run the collector locally using Docker Compose
+
+### Managing secrets
+
+Create an `.env` file:
+
+```
+cp .env.sample .env
+```
+
+Fill it out with your project details. You'll need your project ref and service role key, which you can find [here](https://app.supabase.com/project/_/settings/api).
+
+### Running with Docker
+
+After that, simply start docker compose and you will be able to access Grafana
+
+```
+docker compose up
+```
+
+### Accessing the dashboard
+
+Visit [localhost:8000](https://localhost:8000) and login with the credentials:
+
+- Username: `admin`
+- Password: [the password in your `.env` file]
+
+
+## Deploying
+
+Deploy this service to a server which is always running to continuously collect metrics for your Supabase project.
+
+### Using Fly.io
+
+You can run the collector on a free instance of [Fly.io](https://fly.io/)
+
+Follow these steps:
+
+1. Make sure you have the [Fly CLI](https://fly.io/docs/getting-started/installing-flyctl/) installed, and you are logged in.
+2. Run `fly launch` to deploy the app to Fly.
+3. Copy your `.env` file to your Fly project: `fly secrets set $(cat .env | xargs)`
+4. After a successful deployment, your app will be available at `https://<your-app-name>.fly.dev`

docker-compose.yml

@@ -0,0 +1,12 @@
+version: "3.8"
+
+services:
+  supabase-grafana:
+    build: ./
+    ports:
+      - 8000:8080
+    environment:
+      SUPABASE_PROJECT_REF: ${SUPABASE_PROJECT_REF}
+      SUPABASE_SERVICE_ROLE_KEY: ${SUPABASE_SERVICE_ROLE_KEY}
+      PASSWORD_PROTECTED: ${PASSWORD_PROTECTED}
+      GRAFANA_PASSWORD: ${GRAFANA_PASSWORD}