Giter VIP home page Giter VIP logo

cloudflare-worker-matrix-well-known's Introduction

cloudflare-worker-matrix-well-known

.well-known/matrix/* handler as a CF worker

Commitizen friendly build

This Cloudflare Function allows to serve .well-known Matrix.org server delegations from your Cloudflare Pages static site main domain, like your-blog.com and run Matrix.org server on some subdomain, for example matrix.your-blog.com:1234.

The exact details of how server name resolution works can be found in the spec.

Delegation allows you to specify the server name and port that your Matrix.org installation is reachable at, or to host the Matrix.org server at a different server name to the domain that is being delegated.

For example, if your Matrix.Org server installation is actually reachable at matrix.example.com port 8448, you will be able to delegate from example.com to matrix.example.com so that your users will have @user:example.com user names instead of @user:matrix.example.com usernames.

Delegation can be performed in one of two ways:

Well-known delegation (preferred): A well-known text file is served over HTTPS on the domain name that you want to use, pointing to your server on matrix.example.com port 8448;
DNS SRV delegation (not recommended): See the SRV delegation section below for details.

Using well-known delegation requires that you are running a web server at example.com which is listening on the standard HTTPS port TCP/443.

Assuming that your Matrix.org installation is listening for HTTPS connections at matrix.example.com on port 8448, the delegation file must be served at https://example.com/.well-known/matrix/server and contain the following JSON document:

{
    "m.server": "matrix.example.com:8448"
}

License

Apache 2.0

cloudflare-worker-matrix-well-known's People

Contributors

dependabot[bot] avatar franchb avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

cloudflare-worker-matrix-well-known's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.