add dev-postgres-powersync environment

Author: Dieterbe

dev-postgres-powersync/.env

@@ -0,0 +1,20 @@
+# ==================== Postgres credentials ================================
+PG_DATABASE_NAME=wger
+PG_DATABASE_PORT=5432
+PG_DATABASE_USER=wger
+PG_DATABASE_PASSWORD=wger
+
+# ==================== Demo config =========================================
+DEMO_BACKEND_PORT=6061
+# The front-end demo application is accessible at this port on the host machine
+DEMO_CLIENT_PORT=3030
+PS_JWKS_URL=http://demo-backend:${DEMO_BACKEND_PORT}/api/get_keys/
+
+# These can be generated by following the instructions in the `key-generator` folder
+# A temporary key will be used if these are not specified
+DEMO_JWKS_PUBLIC_KEY=
+DEMO_JWKS_PRIVATE_KEY=
+
+# ==================== PowerSync variables ====================
+# The PowerSync API is accessible via this port
+PS_PORT=8080

dev-postgres-powersync/config-powersync/powersync.yaml

@@ -0,0 +1,97 @@
+# yaml-language-server: $schema=../schema/schema.json
+
+# Note that this example uses YAML custom tags for environment variable substitution.
+# Using `!env [variable name]` will substitute the value of the environment variable named
+# [variable name].
+#
+# Only environment variables with names starting with `PS_` can be substituted.
+#
+# e.g. With the environment variable `export PS_MONGO_URI=mongodb://localhost:27017`
+# and YAML code:
+#  uri: !env PS_MONGO_URI
+# The YAML will resolve to:
+#  uri: mongodb://localhost:27017
+#
+# If using VS Code see the `.vscode/settings.json` definitions which define custom tags.
+
+# migrations:
+#   # Migrations run automatically by default.
+#   # Setting this to true will skip automatic migrations.
+#   # Migrations can be triggered externally by altering the container `command`.
+#   disable_auto_migration: true
+
+# Settings for telemetry reporting
+# See https://docs.powersync.com/self-hosting/telemetry
+telemetry:
+  # Opt out of reporting anonymized usage metrics to PowerSync telemetry service
+  disable_telemetry_sharing: false
+
+# Settings for source database replication
+replication:
+  # Specify database connection details
+  # Note only 1 connection is currently supported
+  # Multiple connection support is on the roadmap
+  connections:
+    - type: postgresql
+      # The PowerSync server container can access the Postgres DB via the DB's service name.
+      # In this case the hostname is db
+
+      # The connection URI or individual parameters can be specified.
+      # Individual params take precedence over URI params
+      uri: !env PS_PG_URI
+
+      # Or use individual params
+
+      # hostname: db # From the Docker Compose service name
+      # port: 5432
+      # database: postgres
+      # username: postgres
+      # password: mypassword
+
+      # SSL settings
+      sslmode: disable # 'verify-full' (default) or 'verify-ca' or 'disable'
+      # 'disable' is OK for local/private networks, not for public networks
+
+      # Required for verify-ca, optional for verify-full
+      # cacert: ${PS_PG_CA_CERT}
+
+      # Include a certificate here for HTTPs
+      # client_certificate: ${PS_PG_CLIENT_CERT}
+      # client_private_key: ${PS_PG_CLIENT_PRIVATE_KEY}
+
+# This is valid if using the `mongo` service defined in `ps-mongo.yaml`
+
+# Connection settings for sync bucket storage
+storage:
+  type: mongodb
+  uri: !env PS_MONGO_URI
+  # Use these if authentication is required. The user should have `readWrite` and `dbAdmin` roles
+  # username: my-mongo-user
+  # password: my-password
+
+# The port which the PowerSync API server will listen on
+port: !env PS_PORT
+
+# Specify sync rules
+sync_rules:
+  path: sync_rules.yaml
+
+# Client (application end user) authentication settings
+client_auth:
+  # Enable this if using Supabase Auth
+  # supabase: true
+
+  # JWKS URIs can be specified here
+  jwks_uri: !env PS_JWKS_URL
+
+  # Optional static collection of public keys for JWT verification
+  # jwks:
+  #   keys:
+  #     - kty: 'RSA'
+  #       n: '${PS_JWK_N}'
+  #       e: '${PS_JWK_E}'
+  #       alg: 'RS256'
+  #       kid: '${PS_JWK_KID}'
+
+  # JWKS audience
+  audience: ["powersync-dev", "powersync"]

dev-postgres-powersync/config-powersync/sync_rules.yaml

@@ -0,0 +1,11 @@
+# See Documentation for more information:
+# https://docs.powersync.com/usage/sync-rules
+# Note that changes to this file are not watched.
+# The service needs to be restarted for changes to take effect.
+bucket_definitions:
+  user_lists:
+    # Separate bucket per todo list
+    parameters: select id as list_id from lists where owner_id = token_parameters.user_id
+    data:
+      - select * from lists where id = bucket.list_id
+      - select * from todos where list_id = bucket.list_id

dev-postgres-powersync/docker-compose.yml

@@ -0,0 +1,66 @@
+name: wger-dev-postgres-powersync
+
+services:
+  web:
+    image: wger/server:powersync
+    depends_on:
+      db:
+        condition: service_healthy
+    env_file:
+      - ../config/prod.env
+      - ../config/dev.env
+    # django backend should do some powersync stuff..
+    environment:
+      # From the PowerSync service name
+      # This is just used to populate the JWT audience
+      POWERSYNC_URL: powersync-dev
+
+      # Keys here for demonstration
+      POWERSYNC_PUBLIC_KEY: ${DEMO_JWKS_PUBLIC_KEY}
+      POWERSYNC_PRIVATE_KEY: ${DEMO_JWKS_PRIVATE_KEY}
+    volumes:
+      - type: bind
+        source: /home/dieter/code/wger-wger
+        target: /home/wger/src
+    ports:
+      - "8000:8000"
+
+  cache:
+    image: redis
+    expose:
+      - 6379
+    healthcheck:
+      test: redis-cli ping
+      interval: 10s
+      timeout: 5s
+      retries: 5
+      start_period: 30s
+    restart: unless-stopped
+
+  db:
+    image: postgres:15-alpine
+    environment:
+      - POSTGRES_USER=wger
+      - POSTGRES_PASSWORD=wger
+      - POSTGRES_DB=wger
+    volumes:
+      - postgres-data:/var/lib/postgresql/data/
+    ports:
+      - "5432:5432"
+    expose:
+      - 5432
+    command: ["postgres", "-c", "wal_level=logical"]
+    healthcheck:
+      test: pg_isready -U wger
+      interval: 10s
+      timeout: 5s
+      retries: 5
+      start_period: 30s
+    restart: unless-stopped
+
+volumes:
+  postgres-data:
+
+include:
+  - path: powersync-services/mongo.yaml
+  - path: powersync-services/powersync.yaml

dev-postgres-powersync/powersync-services/mongo.yaml

@@ -0,0 +1,24 @@
+services:
+  # MongoDB Service used internally
+  mongo:
+    image: mongo:7.0
+    command: --replSet rs0 --bind_ip_all --quiet
+    restart: unless-stopped
+    ports:
+      - 27017:27017
+    volumes:
+      - mongo_storage:/data/db
+
+  # Initializes the MongoDB replica set. This service will not usually be actively running
+  mongo-rs-init:
+    image: mongo:7.0
+    depends_on:
+      - mongo
+    restart: on-failure
+    entrypoint:
+      - bash
+      - -c
+      - 'mongosh --host mongo:27017 --eval ''try{rs.status().ok && quit(0)} catch {} rs.initiate({_id: "rs0", version: 1, members: [{ _id: 0, host : "mongo:27017" }]})'''
+
+volumes:
+  mongo_storage:

dev-postgres-powersync/powersync-services/powersync.yaml

@@ -0,0 +1,73 @@
+services:
+  powersync:
+    depends_on:
+      mongo-rs-init:
+        condition: service_completed_successfully
+    restart: unless-stopped
+    image: journeyapps/powersync-service:latest
+    # The unified service runs an API server and replication worker in the same container.
+    # These services can be executed in different containers by using individual entry commands e.g.
+    # Start only the API server with
+    #   command: ['start', '-r', 'api']
+    # Start only the replication worker with
+    #   command: ['start', '-r', 'sync']
+
+    # Migations occur automatically by default. Default migrations can be disabled in `powersync.yaml`:
+    #  migrations:
+    #   disable_auto_migration: true
+    #
+    # Service migrations can be manually triggered by starting a container with the
+    # following command:
+    #     command: ['migrate', 'up']
+    # Note that this container must finish executing before starting the sync or unified container.
+    command: ["start", "-r", "unified"]
+    volumes:
+      # Mounts the specified config folder to the container
+      # This folder should contain `powersync.yaml and sync_rules.yaml
+      - ../config-powersync:/config
+    environment:
+      # This is the path (inside the container) to the YAML config file
+      # Alternatively the config path can be specified in the command
+      # e.g:
+      #   command: ['start', '-r', 'unified', '-c', '/config/powersync.yaml']
+      #
+      # The config file can also be specified in Base 64 encoding
+      # e.g.: Via an environment variable
+      #   POWERSYNC_CONFIG_B64: [base64 encoded content]
+      # or e.g.: Via a command line parameter
+      #    command: ['start', '-r', 'unified', '-c64', '[base64 encoded content]']
+      POWERSYNC_CONFIG_PATH: /config/powersync.yaml
+
+      # Sync rules can be specified as base 64 encoded YAML
+      # e.g: Via an environment variable
+      # POWERSYNC_SYNC_RULES_B64: "[base64 encoded sync rules]"
+      # or e.g.: Via a command line parameter
+      #     command: ['start', '-r', 'unified', '-sync64', '[base64 encoded content]']
+
+      # The following will be inserted into the powersync.yaml file via templating
+      # Templates are used for filesystem and base64 configuration files
+      PS_PG_URI: postgres://${PG_DATABASE_USER}:${PG_DATABASE_PASSWORD}@db:${PG_DATABASE_PORT}/${PG_DATABASE_NAME}
+      PS_MONGO_URI: mongodb://mongo:27017/powersync_demo
+
+      # Note that powersync.yaml->client_auth->allow_local_jwks must be true for local URLs to work
+      PS_JWKS_URL: ${PS_JWKS_URL}
+
+      # The port which the PowerSync API server should run on
+      PS_PORT: ${PS_PORT}
+
+      #  CA certificate for Postgres connection
+      # PS_PG_CA_CERT:
+
+      # Client certificate for Postgres connection
+      # PS_PG_CLIENT_CERT:
+
+      # Client private key for Postgres connection
+      # PS_PG_CLIENT_PRIVATE_KEY:
+
+      # Potential JWKs public key template
+      # PS_JWK_N:
+      # PS_JWK_E:
+      # PS_JWK_KID:
+
+    ports:
+      - ${PS_PORT}:${PS_PORT}