From c5dda3560cce814ad868de6e1b9325fe0c51d83d Mon Sep 17 00:00:00 2001 From: aly Date: Sun, 29 Dec 2024 18:00:19 +1000 Subject: [PATCH] Add matrix-conduwuit.yml --- public/v4/apps/matrix-conduwuit.yml | 89 +++++++++++++++++++++++++++++ 1 file changed, 89 insertions(+) create mode 100644 public/v4/apps/matrix-conduwuit.yml diff --git a/public/v4/apps/matrix-conduwuit.yml b/public/v4/apps/matrix-conduwuit.yml new file mode 100644 index 0000000..5c447df --- /dev/null +++ b/public/v4/apps/matrix-conduwuit.yml @@ -0,0 +1,89 @@ +captainVersion: 4 +services: + $$cap_appname: + image: girlbossceo/conduwuit:$$cap_conduwuit_version + restart: unless-stopped + environment: + CONDUWUIT_SERVER_NAME: '$$cap_conduwuit_server_name' + CONDUWUIT_DATABASE_BACKEND: 'rocksdb' + CONDUWUIT_ALLOW_REGISTRATION: '$$cap_conduwuit_allow_registration' + CONDUWUIT_ALLOW_FEDERATION: '$$cap_conduwuit_allow_federation' + CONDUWUIT_MAX_REQUEST_SIZE: '$$cap_conduwuit_max_request_size' + CONDUWUIT_TRUSTED_SERVERS: '["matrix.org"]' + CONDUWUIT_MAX_CONCURRENT_REQUESTS: '$$cap_conduwuit_max_concurrent_requests' + CONDUWUIT_LOG: 'info,rocket=off,_=off,sled=off' + volumes: + - '$$cap_appname-data:/var/lib/conduwuit' + caproverExtra: + containerHttpPort: '6167' + +caproverOneClickApp: + variables: + - id: '$$cap_conduwuit_version' + label: conduwuit Version + defaultValue: 'latest' + description: It's probably latest + validRegex: '/^v[0-9]{1,}|latest$/' + - id: '$$cap_conduwuit_server_name' + label: 'conduwuit server name' + defaultValue: 'example.com' + description: >- + The domain part for your usernames (e.g. @myusername:example.com). + + You will need to set up .well-known files on that domain (for our example https://example.com/.well-known/matrix/...) + to point to your actual domain (which will probably be something like appname.apps.your-caprover-domain.com). + + You might find the Synapse documentation useful for this: https://matrix-org.github.io/synapse/latest/setup/installation.html#client-well-known-uri + - id: '$$cap_conduwuit_allow_registration' + label: Enable public registration + defaultValue: 'false' + description: >- + Set this to true if you want EVERYONE to be able to register. + It's recommended to set this to false as soon as possible. + + Otherwise, your server might be used by spammers to mass-register accounts, + which will risk your server being banned by other servers. + validRegex: '/^(true|false)$/i' + - id: '$$cap_conduwuit_allow_federation' + label: Enable federation with other homeservers + defaultValue: 'true' + description: >- + Set this to false if you don't want your users to talk to users on other Matrix servers. + validRegex: '/^(true|false)$/i' + - id: '$$cap_conduwuit_max_request_size' + label: Max request size + defaultValue: '20000000' + description: >- + The maximum allowed size for incoming requests, in bytes. + + If you set this higher than 500000000, you will will also need to increase the nginx "client_max_body_size". + validRegex: '/^[0-9]{2,}$/' + - id: '$$cap_conduwuit_max_concurrent_requests' + label: Maximum number of concurrent requests + defaultValue: '100' + instructions: + start: >- + conduwuit is a very cool, featureful fork of Conduit + + More information about matrix can be found here: https://matrix.org/. + + More information about Conduit in particular is available on https://conduit.rs/. + + More information about conduwuit in specific is available on https://github.com/girlbossceo/conduwuit + end: >- + Almost done. + + Enable and force https in the web interface! + + Unless you have set up .well-known files for other servers to find your server, you can not message users on other servers. + + To set up a .well-known file for Clients, go to https://matrix-org.github.io/synapse/latest/setup/installation.html#client-well-known-uri + + Else, $$cap_appname.$$cap_root_domain is the domain you enter in the custom homeserver field of your client. + + Remember this is just the server, you also need a client like https://app.element.io/ to use this app. + + displayName: 'conduwuit' + isOfficial: false + description: 'Server for the matrix protocol, written in Rust, forked by literal queer dogs' + documentation: 'https://gitlab.com/famedly/conduit/-/blob/next/README.md' \ No newline at end of file