Updated MMR docs with updated fields in main.yaml (#3047)

* Updated MMR docs with updated fields in main.yaml

* Removed uneeded placeholder db password

docs/configuring-playbook-matrix-media-repo.md

@@ -43,69 +43,47 @@ matrix_media_repo_database_max_connections: 25
 matrix_media_repo_database_max_idle_connections: 5
 
 # These users have full access to the administrative functions of the media repository.
-# See https://github.com/turt2live/matrix-media-repo/blob/release-v1.2.8/docs/admin.md for 
+# See docs/admin.md for information on what these people can do. They must belong to one of the
-# information on what these people can do. They must belong to one of the configured 
+# configured homeservers above.
-# homeservers above.
+# matrix_media_repo_admins: [
-matrix_media_repo_admins:
+#   "@your_username:example.org"
-  admins: []
+# ]
-# admins:
+
-#   - "@your_username:example.org"
+matrix_media_repo_admins: []
-
+
-# Datastores are places where media should be persisted. This isn't dedicated for just uploads:
+# Datastores can be split into many areas when handling uploads. Media is still de-duplicated
-# thumbnails and other misc data is also stored in these places. The media repo, when looking
+# across all datastores (local content which duplicates remote content will re-use the remote
-# for a datastore to use, will always use the smallest datastore first.
+# content's location). This option is useful if your datastore is becoming very large, or if
-matrix_media_repo_datastores:
+# you want faster storage for a particular kind of media.
-  datastores:
+#
-    - type: file
+# To disable this datastore, making it readonly, specify `forKinds: []`.
-      enabled: true # Enable this to set up data storage.
+#
-      # Datastores can be split into many areas when handling uploads. Media is still de-duplicated
+# The kinds available are:
-      # across all datastores (local content which duplicates remote content will re-use the remote
+#   thumbnails    - Used to store thumbnails of media (local and remote).
-      # content's location). This option is useful if your datastore is becoming very large, or if
+#   remote_media  - Original copies of remote media (servers not configured by this repo).
-      # you want faster storage for a particular kind of media.
+#   local_media   - Original uploads for local media.
-      #
+#   archives      - Archives of content (GDPR and similar requests).
-      # The kinds available are:
+matrix_media_repo_datastore_file_for_kinds: ["thumbnails", "remote_media", "local_media", "archives"]
-      #   thumbnails    - Used to store thumbnails of media (local and remote).
+matrix_media_repo_datastore_s3_for_kinds: []
-      #   remote_media  - Original copies of remote media (servers not configured by this repo).
+
-      #   local_media   - Original uploads for local media.
+# The s3 uploader needs a temporary location to buffer files to reduce memory usage on
-      #   archives      - Archives of content (GDPR and similar requests).
+# small file uploads. If the file size is unknown, the file is written to this location
-      forKinds: ["thumbnails", "remote_media", "local_media", "archives"]
+# before being uploaded to s3 (then the file is deleted). If you aren't concerned about
-      opts:
+# memory usage, set this to an empty string.
-        path: /data/media
+matrix_media_repo_datastore_s3_opts_temp_path: ""
-
+matrix_media_repo_datastore_s3_opts_endpoint: "sfo2.digitaloceanspaces.com"
-    - type: s3
+matrix_media_repo_datastore_s3_opts_access_key_id: ""
-      enabled: false # Enable this to set up s3 uploads
+matrix_media_repo_datastore_s3_opts_access_secret: ""
-      forKinds: ["thumbnails", "remote_media", "local_media", "archives"]
+matrix_media_repo_datastore_s3_opts_ssl: true
-      opts:
+matrix_media_repo_datastore_s3_opts_bucket_name: "your-media-bucket"
-        # The s3 uploader needs a temporary location to buffer files to reduce memory usage on
+
-        # small file uploads. If the file size is unknown, the file is written to this location
+# An optional region for where this S3 endpoint is located. Typically not needed, though
-        # before being uploaded to s3 (then the file is deleted). If you aren't concerned about
+# some providers will need this (like Scaleway). Uncomment to use.
-        # memory usage, set this to an empty string.
+# matrix_media_repo_datastore_s3_opts_region: "sfo2"
-        tempPath: "/tmp/mediarepo_s3_upload"
+
-        endpoint: sfo2.digitaloceanspaces.com
+# An optional storage class for tuning how the media is stored at s3.
-        accessKeyId: ""
+# See https://aws.amazon.com/s3/storage-classes/ for details; uncomment to use.
-        accessSecret: ""
+# matrix_media_repo_datastore_s3_opts_storage_class: "STANDARD"
-        ssl: true
-        bucketName: "your-media-bucket"
-        # An optional region for where this S3 endpoint is located. Typically not needed, though
-        # some providers will need this (like Scaleway). Uncomment to use.
-        #region: "sfo2"
-        # An optional storage class for tuning how the media is stored at s3.
-        # See https://aws.amazon.com/s3/storage-classes/ for details; uncomment to use.
-        #storageClass: STANDARD
-
-    # The media repo does support an IPFS datastore, but only if the IPFS feature is enabled. If
-    # the feature is not enabled, this will not work. Note that IPFS support is experimental at
-    # the moment and not recommended for general use.
-    #
-    # NOTE: Everything you upload to IPFS will be publicly accessible, even when the media repo
-    # puts authentication on the download endpoints. Only use this option for cases where you
-    # expect your media to be publicly accessible.
-    - type: ipfs
-      enabled: false # Enable this to use IPFS support
-      forKinds: ["local_media"]
-      # The IPFS datastore currently has no options. It will use the daemon or HTTP API configured
-      # in the IPFS section of your main config.
-      opts: {}
 
 ```
 

roles/custom/matrix-media-repo/defaults/main.yml

@@ -124,7 +124,7 @@ matrix_media_repo_federation_ignored_hosts: []
 # Do NOT put your homeserver's existing database credentials here. Create a new database and
 # user instead. Using the same server is fine, just not the same username and database.
 matrix_media_repo_database_username: "matrix_media_repo"
-matrix_media_repo_database_password: "your_password"
+matrix_media_repo_database_password: ""
 matrix_media_repo_database_hostname: "{{ devture_postgres_identifier }}"
 matrix_media_repo_database_port: 5432
 matrix_media_repo_database_name: "matrix_media_repo"
@@ -289,7 +289,7 @@ matrix_media_repo_datastore_s3_for_kinds: []
 # small file uploads. If the file size is unknown, the file is written to this location
 # before being uploaded to s3 (then the file is deleted). If you aren't concerned about
 # memory usage, set this to an empty string.
-matrix_media_repo_datastore_s3_opts_temp_path: "/tmp/mediarepo_s3_upload"
+matrix_media_repo_datastore_s3_opts_temp_path: ""
 matrix_media_repo_datastore_s3_opts_endpoint: "sfo2.digitaloceanspaces.com"
 matrix_media_repo_datastore_s3_opts_access_key_id: ""
 matrix_media_repo_datastore_s3_opts_access_secret: ""