From 6feef7abd53d3dfd33e105be036295f7ba134461 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Kalbermatter?= Date: Thu, 16 May 2024 09:34:51 +0200 Subject: [PATCH] feat: update values to include permissions --- README.md | 35 ++++++++++++++++++++------ values.yaml | 71 ++++++++++++++++++++++++++++------------------------- 2 files changed, 64 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 87b3077..c209ef4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # mautrix-discord -[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/mautrix-discord)](https://artifacthub.io/packages/search?repo=mautrix-discord) ![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.6.5](https://img.shields.io/badge/AppVersion-0.6.5-informational?style=flat-square) A Matrix-Discord puppeting bridge. @@ -39,7 +38,7 @@ A Matrix-Discord puppeting bridge. | config.appservice.hostname | string | `"0.0.0.0"` | | | config.appservice.hs_token | string | `"This value is generated when generating the registration"` | | | config.appservice.id | string | `"discord"` | | -| config.appservice.port | int | `80` | | +| config.appservice.port | int | `29334` | | | config.bridge.animated_sticker.args.fps | int | `25` | | | config.bridge.animated_sticker.args.height | int | `320` | | | config.bridge.animated_sticker.args.width | int | `320` | | @@ -47,18 +46,22 @@ A Matrix-Discord puppeting bridge. | config.bridge.autojoin_thread_on_open | bool | `true` | | | config.bridge.backfill.forward_limits.initial.channel | int | `0` | | | config.bridge.backfill.forward_limits.initial.dm | int | `0` | | +| config.bridge.backfill.forward_limits.initial.thread | int | `0` | | | config.bridge.backfill.forward_limits.missed.channel | int | `0` | | | config.bridge.backfill.forward_limits.missed.dm | int | `0` | | +| config.bridge.backfill.forward_limits.missed.thread | int | `0` | | | config.bridge.backfill.max_guild_members | int | `-1` | | -| config.bridge.channel_name_template | string | `"{{ \"{{if or (eq .Type 3) (eq .Type 4)}}{{.Name}}{{else}}#{{.Name}}{{end}}\" }}"` | | +| config.bridge.cache_media | string | `"unencrypted"` | | +| config.bridge.channel_name_template | string | `"{{ \"{{if or (eq .Type 3) (eq .Type 4)}}{{.Name}}{{else if eq .Type 1}}{{.Name}} (Discord){{else}}#{{.Name}}{{end}}\" }}"` | | | config.bridge.command_prefix | string | `"!discord"` | | | config.bridge.custom_emoji_reactions | bool | `true` | | | config.bridge.delete_portal_on_channel_delete | bool | `false` | | | config.bridge.delivery_receipts | bool | `false` | | -| config.bridge.displayname_template | string | `"{{ \"{{.Username}}#{{.Discriminator}}{{if .Bot}} (bot){{end}}\" }}"` | | +| config.bridge.displayname_template | string | `"{{ \"{{or .GlobalName .Username}}{{if .Bot}} (bot){{end}} (Discord)\" }}"` | | | config.bridge.double_puppet_allow_discovery | bool | `false` | | | config.bridge.double_puppet_server_map | object | `{}` | | | config.bridge.embed_fields_as_tables | bool | `true` | | +| config.bridge.enable_webhook_avatars | bool | `true` | | | config.bridge.encryption.allow | bool | `false` | | | config.bridge.encryption.allow_key_sharing | bool | `false` | | | config.bridge.encryption.appservice | bool | `false` | | @@ -66,11 +69,14 @@ A Matrix-Discord puppeting bridge. | config.bridge.encryption.delete_keys.delete_fully_used_on_decrypt | bool | `false` | | | config.bridge.encryption.delete_keys.delete_on_device_delete | bool | `false` | | | config.bridge.encryption.delete_keys.delete_outbound_on_ack | bool | `false` | | +| config.bridge.encryption.delete_keys.delete_outdated_inbound | bool | `false` | | | config.bridge.encryption.delete_keys.delete_prev_on_new_session | bool | `false` | | | config.bridge.encryption.delete_keys.dont_store_outbound | bool | `false` | | | config.bridge.encryption.delete_keys.periodically_delete_expired | bool | `false` | | | config.bridge.encryption.delete_keys.ratchet_on_decrypt | bool | `false` | | +| config.bridge.encryption.plaintext_mentions | bool | `false` | | | config.bridge.encryption.require | bool | `false` | | +| config.bridge.encryption.rotation.disable_device_change_key_rotation | bool | `false` | | | config.bridge.encryption.rotation.enable_custom | bool | `false` | | | config.bridge.encryption.rotation.messages | int | `100` | | | config.bridge.encryption.rotation.milliseconds | int | `604800000` | | @@ -84,11 +90,19 @@ A Matrix-Discord puppeting bridge. | config.bridge.management_room_text.welcome | string | `"Hello, I'm a Discord bridge bot."` | | | config.bridge.management_room_text.welcome_connected | string | `"Use `help` for help."` | | | config.bridge.management_room_text.welcome_unconnected | string | `"Use `help` for help or `login` to log in."` | | +| config.bridge.media_patterns.attachments | string | `"mxc://discord-media.mau.dev/attachments|{{.ChannelID}}|{{.AttachmentID}}|{{.FileName}}"` | | +| config.bridge.media_patterns.avatars | string | `"mxc://discord-media.mau.dev/avatars|{{.UserID}}|{{.AvatarID}}.{{.Ext}}"` | | +| config.bridge.media_patterns.emojis | string | `"mxc://discord-media.mau.dev/emojis|{{.ID}}.{{.Ext}}"` | | +| config.bridge.media_patterns.enabled | bool | `false` | | +| config.bridge.media_patterns.stickers | string | `"mxc://discord-media.mau.dev/stickers|{{.ID}}.{{.Ext}}"` | | | config.bridge.message_error_notices | bool | `true` | | | config.bridge.message_status_events | bool | `false` | | | config.bridge.mute_channels_on_create | bool | `false` | | -| config.bridge.permissions | object | `{}` | | +| config.bridge.permissions."@admin:example.com" | string | `"admin"` | | +| config.bridge.permissions."example.com" | string | `"user"` | | +| config.bridge.permissions.* | string | `"relay"` | | | config.bridge.portal_message_buffer | int | `128` | | +| config.bridge.prefix_webhook_messages | bool | `false` | | | config.bridge.private_chat_portal_meta | string | `"default"` | | | config.bridge.provisioning.prefix | string | `"/_matrix/provision"` | | | config.bridge.provisioning.shared_secret | string | `"generate"` | | @@ -96,13 +110,16 @@ A Matrix-Discord puppeting bridge. | config.bridge.restricted_rooms | bool | `true` | | | config.bridge.startup_private_channel_create_limit | int | `5` | | | config.bridge.sync_direct_chat_list | bool | `false` | | +| config.bridge.use_discord_cdn_upload | bool | `true` | | | config.bridge.username_template | string | `"discord_{{ \"{{.}}\" }}"` | | | config.homeserver.address | string | `""` | | | config.homeserver.async_media | bool | `false` | | | config.homeserver.domain | string | `""` | | | config.homeserver.message_send_checkpoint_endpoint | string | `nil` | | +| config.homeserver.ping_interval_seconds | int | `0` | | | config.homeserver.software | string | `"standard"` | | | config.homeserver.status_endpoint | string | `nil` | | +| config.homeserver.websocket | bool | `false` | | | config.logging.directory | string | `"/data/logs"` | | | config.logging.file_date_format | string | `"2006-01-02"` | | | config.logging.file_json | bool | `false` | | @@ -115,7 +132,7 @@ A Matrix-Discord puppeting bridge. | fullnameOverride | string | `""` | | | image.pullPolicy | string | `"IfNotPresent"` | | | image.repository | string | `"dock.mau.dev/mautrix/discord"` | | -| image.tag | string | `"{{ .Chart.AppVersion }}"` | | +| image.tag | string | `"v{{ .Chart.AppVersion }}"` | | | imagePullSecrets | list | `[]` | | | ingress.annotations | object | `{}` | | | ingress.class | string | `nil` | | @@ -141,6 +158,7 @@ A Matrix-Discord puppeting bridge. | probes.startup.initialDelaySeconds | int | `5` | | | probes.startup.periodSeconds | int | `10` | | | registration.rate_limited | bool | `false` | | +| registration.sender_localpart | string | `"discordbridgebot"` | | | replicaCount | int | `1` | | | resources.limits.cpu | int | `1` | | | resources.limits.memory | string | `"128Mi"` | | @@ -149,11 +167,12 @@ A Matrix-Discord puppeting bridge. | securityContext | object | `{}` | | | service.clusterIP | string | `"None"` | | | service.externalTrafficPolicy | string | `nil` | | -| service.port | int | `80` | | +| service.port | int | `29334` | | | service.type | string | `"ClusterIP"` | | | serviceAccount.annotations | object | `{}` | | | serviceAccount.create | bool | `true` | | | serviceAccount.name | string | `nil` | | | tolerations | list | `[]` | | ----------------------------------------------- \ No newline at end of file +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1) diff --git a/values.yaml b/values.yaml index 90477f5..40c5c1f 100644 --- a/values.yaml +++ b/values.yaml @@ -6,12 +6,12 @@ replicaCount: 1 image: repository: dock.mau.dev/mautrix/discord - tag: "v{{ .Chart.AppVersion }}" + tag: 'v{{ .Chart.AppVersion }}' pullPolicy: IfNotPresent imagePullSecrets: [] -nameOverride: "" -fullnameOverride: "" +nameOverride: '' +fullnameOverride: '' serviceAccount: # Specifies whether a service account should be created @@ -27,10 +27,11 @@ podSecurityContext: # You can safely remove it if you change config.appservice.port to something above 1024. sysctls: - name: net.ipv4.ip_unprivileged_port_start - value: "0" + value: '0' # fsGroup: 2000 -securityContext: {} +securityContext: + {} # privileged: true # capabilities: # drop: @@ -43,7 +44,7 @@ service: externalTrafficPolicy: type: ClusterIP clusterIP: None - port: 80 + port: 29334 probes: liveness: @@ -61,9 +62,9 @@ config: # Homeserver details. homeserver: # The address that this appservice can use to connect to the homeserver. - address: "" + address: '' # The domain of the homeserver (also known as server_name, used for MXIDs, etc). - domain: "" + domain: '' # What software is the homeserver running? # Standard Matrix homeservers like Synapse, Dendrite and Conduit should just use "standard" here. software: standard @@ -86,10 +87,10 @@ config: # Changing these values requires regeneration of the registration. appservice: # The address that the homeserver can use to connect to this appservice. - address: "" + address: '' # The hostname and port where this appservice should listen. hostname: 0.0.0.0 - port: 80 + port: 29334 # Database config. database: # The database type. "sqlite3-fk-wal" and "postgres" are supported. @@ -129,8 +130,8 @@ config: async_transactions: false # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify. - as_token: "This value is generated when generating the registration" - hs_token: "This value is generated when generating the registration" + as_token: 'This value is generated when generating the registration' + hs_token: 'This value is generated when generating the registration' # Bridge config bridge: @@ -222,16 +223,16 @@ config: # Each of the patterns can be set to null to disable custom URIs for that type of media. # More details can be found at https://docs.mau.fi/bridges/go/discord/direct-media.html media_patterns: - # Should custom mxc:// URIs be used instead of reuploading media? - enabled: false - # Pattern for normal message attachments. - attachments: mxc://discord-media.mau.dev/attachments|{{.ChannelID}}|{{.AttachmentID}}|{{.FileName}} - # Pattern for custom emojis. - emojis: mxc://discord-media.mau.dev/emojis|{{.ID}}.{{.Ext}} - # Pattern for stickers. Note that animated lottie stickers will not be converted if this is enabled. - stickers: mxc://discord-media.mau.dev/stickers|{{.ID}}.{{.Ext}} - # Pattern for static user avatars. - avatars: mxc://discord-media.mau.dev/avatars|{{.UserID}}|{{.AvatarID}}.{{.Ext}} + # Should custom mxc:// URIs be used instead of reuploading media? + enabled: false + # Pattern for normal message attachments. + attachments: mxc://discord-media.mau.dev/attachments|{{.ChannelID}}|{{.AttachmentID}}|{{.FileName}} + # Pattern for custom emojis. + emojis: mxc://discord-media.mau.dev/emojis|{{.ID}}.{{.Ext}} + # Pattern for stickers. Note that animated lottie stickers will not be converted if this is enabled. + stickers: mxc://discord-media.mau.dev/stickers|{{.ID}}.{{.Ext}} + # Pattern for static user avatars. + avatars: mxc://discord-media.mau.dev/avatars|{{.UserID}}|{{.AvatarID}}.{{.Ext}} # Settings for converting animated stickers. animated_sticker: # Format to which animated stickers should be converted. @@ -247,7 +248,8 @@ config: height: 320 fps: 25 # only for webm, webp and gif (2, 5, 10, 20 or 25 recommended) # Servers to always allow double puppeting from - double_puppet_server_map: {} + double_puppet_server_map: + {} #example.com: https://example.com # Allow using double puppeting from any server with a valid client .well-known file. double_puppet_allow_discovery: false @@ -256,7 +258,8 @@ config: # If set, double puppeting will be enabled automatically for local users # instead of users having to find an access token and run `login-matrix` # manually. - login_shared_secret_map: {} + login_shared_secret_map: + {} #example.com: foobar # The prefix for commands. Only required in non-management rooms. @@ -267,11 +270,11 @@ config: # Sent when joining a room. welcome: "Hello, I'm a Discord bridge bot." # Sent when joining a management room and the user is already logged in. - welcome_connected: "Use `help` for help." + welcome_connected: 'Use `help` for help.' # Sent when joining a management room and the user is not logged in. - welcome_unconnected: "Use `help` for help or `login` to log in." + welcome_unconnected: 'Use `help` for help or `login` to log in.' # Optional extra text sent when joining a management room. - additional_help: "" + additional_help: '' # Settings for backfilling messages. backfill: @@ -391,15 +394,15 @@ config: # * - All Matrix users # domain - All users on that homeserver # mxid - Specific user - permissions: {} - #"*": relay - #"example.com": user - #"@admin:example.com": admin + permissions: + '*': relay + 'example.com': user + '@admin:example.com': admin logging: directory: /data/logs file_name_format: '{{ "{{.Date}}-{{.Index}}.log" }}' - file_date_format: "2006-01-02" + file_date_format: '2006-01-02' file_mode: 384 timestamp_format: Jan _2, 2006 15:04:05 print_level: debug @@ -451,7 +454,7 @@ persistence: ## set, choosing the default provisioner. (gp2 on AWS, standard on ## GKE, AWS & OpenStack) ## - existingClaim: "" - storageClass: "" + existingClaim: '' + storageClass: '' accessMode: ReadWriteOnce size: 128Mi