Add docs

examples/docker-compose.scheduled.s3.yaml

@@ -1,21 +1,31 @@
-version: "3"
 services:
   pg-bkup:
+    # In production, it is advised to lock your image tag to a proper
+    # release version instead of using `latest`.
+    # Check https://github.com/jkaninda/pg-bkup/releases
+    # for a list of available releases.
     image: jkaninda/pg-bkup
     container_name: pg-bkup
-    privileged: true
-    devices:
-    - "/dev/fuse"
     command:
       - /bin/sh
       - -c
-      - pg-bkup backup --storage s3 --path /mys3_custom_path --dbname database_name --mode scheduled --period "0 1 * * *"
+      - pg-bkup backup --storage s3 -d my-database --mode scheduled --period "0 1 * * *"
     environment:
       - DB_PORT=5432
-      - DB_HOST=postgress
-      - DB_USERNAME=userName
-      - DB_PASSWORD=${DB_PASSWORD}
-      - ACCESS_KEY=${ACCESS_KEY}
-      - SECRET_KEY=${SECRET_KEY}
-      - BUCKET_NAME=${BUCKET_NAME}
-      - S3_ENDPOINT=https://s3.us-west-2.amazonaws.com
+      - DB_HOST=postgres
+      - DB_NAME=database
+      - DB_USERNAME=username
+      - DB_PASSWORD=password
+      ## AWS configurations
+      - AWS_S3_ENDPOINT=https://s3.amazonaws.com
+      - AWS_S3_BUCKET_NAME=backup
+      - AWS_REGION="us-west-2"
+      - AWS_ACCESS_KEY=xxxx
+      - AWS_SECRET_KEY=xxxxx
+      ## In case you are using S3 alternative such as Minio and your Minio instance is not secured, you change it to true
+      - AWS_DISABLE_SSL="false"
+      # pg-bkup container must be connected to the same network with your database
+    networks:
+      - web
+networks:
+  web: