-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
50 additions
and
251 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,275 +1,74 @@ | ||
| .. image:: ./docs/element_logo_white_bg.svg | ||
| :height: 60px | ||
| # Katya ® 👽 AI 🧠 REChain ®️ 🪐 Blockchain Node Network Wiki | ||
|
|
||
| **Element Synapse - Matrix homeserver implementation** | ||
| Welcome to the **Katya AI** and **REChain Blockchain Node Network** Wiki! This documentation provides in-depth information on the Katya AI system, its features, the REChain Blockchain Node Network, and how you can participate as a developer or node operator. | ||
|
|
||
| ## Table of Contents | ||
| 1. [Introduction](./Introduction.md) | ||
| 2. [Key Features of Katya AI and REChain Blockchain Node Network](./Key_Features.md) | ||
| 3. [Node Setup and Configuration](./Node_Setup.md) | ||
| 4. [Katya AI & Blockchain Development Tools](./Development_Tools.md) | ||
| 5. [Security and Privacy in Katya AI](./Security_Privacy.md) | ||
| 6. [Partnerships and Collaborations](./Partnerships.md) | ||
| 7. [Roadmap and Future Development](./Roadmap.md) | ||
| 8. [Frequently Asked Questions (FAQ)](./FAQ.md) | ||
|
|
||
| ## Getting Started | ||
|
|
||
| To get started, explore the following topics: | ||
| - What Katya AI is and how it integrates into the REChain Blockchain Network. | ||
| - Key features like secure messaging, autonomous blockchain operations, and more. | ||
| - Instructions on setting up your own node in the REChain Blockchain Node Network. | ||
| - Development tools and API documentation to integrate and build on Katya AI. | ||
|
|
||
| For any questions or contributions, feel free to check out the [FAQ](./FAQ.md) or explore the repository's source code for additional details. | ||
|
|
||
| |support| |development| |documentation| |license| |pypi| |python| | ||
|
|
||
| Synapse is an open source `Matrix <https://matrix.org>`__ homeserver | ||
| implementation, written and maintained by `Element <https://element.io>`_. | ||
| `Matrix <https://github.com/matrix-org>`__ is the open standard for | ||
| implementation, written and maintained by `REChain Network Solutions`__ is the open standard for | ||
| secure and interoperable real time communications. You can directly run | ||
| and manage the source code in this repository, available under an AGPL | ||
| license. There is no support provided from Element unless you have a | ||
| subscription. | ||
| license. | ||
|
|
||
| Subscription alternative | ||
| ======================== | ||
|
|
||
| Alternatively, for those that need an enterprise-ready solution, Element | ||
| Server Suite (ESS) is `available as a subscription <https://element.io/pricing>`_. | ||
| ESS builds on Synapse to offer a complete Matrix-based backend including the full | ||
| `Admin Console product <https://element.io/enterprise-functionality/admin-console>`_, | ||
| giving admins the power to easily manage an organization-wide | ||
| deployment. It includes advanced identity management, auditing, | ||
| moderation and data retention options as well as Long Term Support and | ||
| SLAs. ESS can be used to support any Matrix-based frontend client. | ||
| Alternatively, for those that need an enterprise-ready solution: | ||
|
|
||
| Short Branding Names for Enterprise | ||
| Here are some branding ideas for enterprise solutions related to this decentralized network: | ||
|
|
||
| NodeLink™ – Emphasizes the distributed nature of the network, connecting businesses with secure, decentralized nodes. | ||
| DecentraNet™ – A short, catchy name that highlights the decentralized and scalable architecture of the blockchain. | ||
| DistribuChain™ – Focuses on the fully distributed aspect, suitable for businesses in logistics or supply chain management. | ||
| BlockSphere™ – A branding name symbolizing a global, interconnected blockchain network with robust security. | ||
| PrivaChain™ – Highlights privacy and security, ideal for industries like healthcare and finance. | ||
|
|
||
| .. contents:: | ||
|
|
||
| 🛠️ Installing and configuration | ||
| =============================== | ||
|
|
||
| The Synapse documentation describes `how to install Synapse <https://element-hq.github.io/synapse/latest/setup/installation.html>`_. We recommend using | ||
| `Docker images <https://element-hq.github.io/synapse/latest/setup/installation.html#docker-images-and-ansible-playbooks>`_ or `Debian packages from Matrix.org | ||
| <https://element-hq.github.io/synapse/latest/setup/installation.html#matrixorg-packages>`_. | ||
|
|
||
| .. _federation: | ||
|
|
||
| Synapse has a variety of `config options | ||
| <https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html>`_ | ||
| which can be used to customise its behaviour after installation. | ||
| There are additional details on how to `configure Synapse for federation here | ||
| <https://element-hq.github.io/synapse/latest/federate.html>`_. | ||
|
|
||
| .. _reverse-proxy: | ||
|
|
||
| Using a reverse proxy with Synapse | ||
| ---------------------------------- | ||
|
|
||
| It is recommended to put a reverse proxy such as | ||
| `nginx <https://nginx.org/en/docs/http/ngx_http_proxy_module.html>`_, | ||
| `Apache <https://httpd.apache.org/docs/current/mod/mod_proxy_http.html>`_, | ||
| `Caddy <https://caddyserver.com/docs/quick-starts/reverse-proxy>`_, | ||
| `HAProxy <https://www.haproxy.org/>`_ or | ||
| `relayd <https://man.openbsd.org/relayd.8>`_ in front of Synapse. One advantage of | ||
| doing so is that it means that you can expose the default https port (443) to | ||
| Matrix clients without needing to run Synapse with root privileges. | ||
| For information on configuring one, see `the reverse proxy docs | ||
| <https://element-hq.github.io/synapse/latest/reverse_proxy.html>`_. | ||
|
|
||
| Upgrading an existing Synapse | ||
| ----------------------------- | ||
|
|
||
| The instructions for upgrading Synapse are in `the upgrade notes`_. | ||
| Please check these instructions as upgrading may require extra steps for some | ||
| versions of Synapse. | ||
|
|
||
| .. _the upgrade notes: https://element-hq.github.io/synapse/develop/upgrade.html | ||
|
|
||
|
|
||
| Platform dependencies | ||
| --------------------- | ||
|
|
||
| Synapse uses a number of platform dependencies such as Python and PostgreSQL, | ||
| and aims to follow supported upstream versions. See the | ||
| `deprecation policy <https://element-hq.github.io/synapse/latest/deprecation_policy.html>`_ | ||
| for more details. | ||
|
|
||
|
|
||
| Security note | ||
| ------------- | ||
|
|
||
| Matrix serves raw, user-supplied data in some APIs -- specifically the `content | ||
| repository endpoints`_. | ||
|
|
||
| .. _content repository endpoints: https://matrix.org/docs/spec/client_server/latest.html#get-matrix-media-r0-download-servername-mediaid | ||
|
|
||
| Whilst we make a reasonable effort to mitigate against XSS attacks (for | ||
| instance, by using `CSP`_), a Matrix homeserver should not be hosted on a | ||
| domain hosting other web applications. This especially applies to sharing | ||
| the domain with Matrix web clients and other sensitive applications like | ||
| webmail. See | ||
| https://developer.github.com/changes/2014-04-25-user-content-security for more | ||
| information. | ||
|
|
||
| .. _CSP: https://github.com/matrix-org/synapse/pull/1021 | ||
|
|
||
| Ideally, the homeserver should not simply be on a different subdomain, but on | ||
| a completely different `registered domain`_ (also known as top-level site or | ||
| eTLD+1). This is because `some attacks`_ are still possible as long as the two | ||
| applications share the same registered domain. | ||
|
|
||
| .. _registered domain: https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-2.3 | ||
|
|
||
| .. _some attacks: https://en.wikipedia.org/wiki/Session_fixation#Attacks_using_cross-subdomain_cookie | ||
|
|
||
| To illustrate this with an example, if your Element Web or other sensitive web | ||
| application is hosted on ``A.example1.com``, you should ideally host Synapse on | ||
| ``example2.com``. Some amount of protection is offered by hosting on | ||
| ``B.example1.com`` instead, so this is also acceptable in some scenarios. | ||
| However, you should *not* host your Synapse on ``A.example1.com``. | ||
|
|
||
| Note that all of the above refers exclusively to the domain used in Synapse's | ||
| ``public_baseurl`` setting. In particular, it has no bearing on the domain | ||
| mentioned in MXIDs hosted on that server. | ||
|
|
||
| Following this advice ensures that even if an XSS is found in Synapse, the | ||
| impact to other applications will be minimal. | ||
|
|
||
|
|
||
| 🧪 Testing a new installation | ||
| ============================= | ||
|
|
||
| The easiest way to try out your new Synapse installation is by connecting to it | ||
| from a web client. | ||
|
|
||
| Unless you are running a test instance of Synapse on your local machine, in | ||
| general, you will need to enable TLS support before you can successfully | ||
| connect from a client: see | ||
| `TLS certificates <https://element-hq.github.io/synapse/latest/setup/installation.html#tls-certificates>`_. | ||
|
|
||
| An easy way to get started is to login or register via Element at | ||
| https://app.element.io/#/login or https://app.element.io/#/register respectively. | ||
| You will need to change the server you are logging into from ``matrix.org`` | ||
| and instead specify a Homeserver URL of ``https://<server_name>:8448`` | ||
| (or just ``https://<server_name>`` if you are using a reverse proxy). | ||
| If you prefer to use another client, refer to our | ||
| `client breakdown <https://matrix.org/ecosystem/clients/>`_. | ||
|
|
||
| If all goes well you should at least be able to log in, create a room, and | ||
| start sending messages. | ||
|
|
||
| .. _`client-user-reg`: | ||
|
|
||
| Registering a new user from a client | ||
| ------------------------------------ | ||
|
|
||
| By default, registration of new users via Matrix clients is disabled. To enable | ||
| it: | ||
|
|
||
| 1. In the | ||
| `registration config section <https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#registration>`_ | ||
| set ``enable_registration: true`` in ``homeserver.yaml``. | ||
| 2. Then **either**: | ||
|
|
||
| a. set up a `CAPTCHA <https://element-hq.github.io/synapse/latest/CAPTCHA_SETUP.html>`_, or | ||
| b. set ``enable_registration_without_verification: true`` in ``homeserver.yaml``. | ||
|
|
||
| We **strongly** recommend using a CAPTCHA, particularly if your homeserver is exposed to | ||
| the public internet. Without it, anyone can freely register accounts on your homeserver. | ||
| This can be exploited by attackers to create spambots targeting the rest of the Matrix | ||
| federation. | ||
|
|
||
| Your new user name will be formed partly from the ``server_name``, and partly | ||
| from a localpart you specify when you create the account. Your name will take | ||
| the form of:: | ||
|
|
||
| @localpart:my.domain.name | ||
|
|
||
| (pronounced "at localpart on my dot domain dot name"). | ||
|
|
||
| As when logging in, you will need to specify a "Custom server". Specify your | ||
| desired ``localpart`` in the 'User name' box. | ||
|
|
||
| 🎯 Troubleshooting and support | ||
| ============================== | ||
|
|
||
| 🚀 Professional support | ||
| ----------------------- | ||
|
|
||
| Enterprise quality support for Synapse including SLAs is available as part of an | ||
| `Element Server Suite (ESS) <https://element.io/pricing>`_ subscription. | ||
|
|
||
| If you are an existing ESS subscriber then you can raise a `support request <https://ems.element.io/support>`_ | ||
| and access the `knowledge base <https://ems-docs.element.io>`_. | ||
|
|
||
| 🤝 Community support | ||
| -------------------- | ||
|
|
||
| The `Admin FAQ <https://element-hq.github.io/synapse/latest/usage/administration/admin_faq.html>`_ | ||
| includes tips on dealing with some common problems. For more details, see | ||
| `Synapse's wider documentation <https://element-hq.github.io/synapse/latest/>`_. | ||
|
|
||
| For additional support installing or managing Synapse, please ask in the community | ||
| support room |room|_ (from a matrix.org account if necessary). We do not use GitHub | ||
| issues for support requests, only for bug reports and feature requests. | ||
|
|
||
| .. |room| replace:: ``#synapse:matrix.org`` | ||
| .. _room: https://matrix.to/#/#synapse:matrix.org | ||
|
|
||
| .. |docs| replace:: ``docs`` | ||
| .. _docs: docs | ||
|
|
||
| 🪪 Identity Servers | ||
| =================== | ||
|
|
||
| Identity servers have the job of mapping email addresses and other 3rd Party | ||
| IDs (3PIDs) to Matrix user IDs, as well as verifying the ownership of 3PIDs | ||
| before creating that mapping. | ||
|
|
||
| **They are not where accounts or credentials are stored - these live on home | ||
| servers. Identity Servers are just for mapping 3rd party IDs to matrix IDs.** | ||
|
|
||
| This process is very security-sensitive, as there is obvious risk of spam if it | ||
| is too easy to sign up for Matrix accounts or harvest 3PID data. In the longer | ||
| term, we hope to create a decentralised system to manage it (`matrix-doc #712 | ||
| <https://github.com/matrix-org/matrix-doc/issues/712>`_), but in the meantime, | ||
| the role of managing trusted identity in the Matrix ecosystem is farmed out to | ||
| a cluster of known trusted ecosystem partners, who run 'Matrix Identity | ||
| Servers' such as `Sydent <https://github.com/matrix-org/sydent>`_, whose role | ||
| is purely to authenticate and track 3PID logins and publish end-user public | ||
| keys. | ||
|
|
||
| You can host your own copy of Sydent, but this will prevent you reaching other | ||
| users in the Matrix ecosystem via their email address, and prevent them finding | ||
| you. We therefore recommend that you use one of the centralised identity servers | ||
| at ``https://matrix.org`` or ``https://vector.im`` for now. | ||
|
|
||
| To reiterate: the Identity server will only be used if you choose to associate | ||
| an email address with your account, or send an invite to another user via their | ||
| email address. | ||
|
|
||
|
|
||
| 🛠️ Development | ||
| ============== | ||
|
|
||
| We welcome contributions to Synapse from the community! | ||
| The best place to get started is our | ||
| `guide for contributors <https://element-hq.github.io/synapse/latest/development/contributing_guide.html>`_. | ||
| This is part of our larger `documentation <https://element-hq.github.io/synapse/latest>`_, which includes | ||
|
|
||
| information for Synapse developers as well as Synapse administrators. | ||
| Developers might be particularly interested in: | ||
|
|
||
| * `Synapse's database schema <https://element-hq.github.io/synapse/latest/development/database_schema.html>`_, | ||
| * `notes on Synapse's implementation details <https://element-hq.github.io/synapse/latest/development/internal_documentation/index.html>`_, and | ||
| * `how we use git <https://element-hq.github.io/synapse/latest/development/git.html>`_. | ||
|
|
||
| Alongside all that, join our developer community on Matrix: | ||
| `#synapse-dev:matrix.org <https://matrix.to/#/#synapse-dev:matrix.org>`_, featuring real humans! | ||
| Th# Fully Decentralized and Distributed Blockchain Network for Everyone | ||
|
|
||
| ## Introduction | ||
| Welcome to the future of blockchain technology! A fully decentralized and distributed network designed for universal access. This platform brings blockchain to everyone, making it easier than ever to participate in a secure, private, and scalable decentralized ecosystem. | ||
|
|
||
| .. |support| image:: https://img.shields.io/badge/matrix-community%20support-success | ||
| :alt: (get community support in #synapse:matrix.org) | ||
| :target: https://matrix.to/#/#synapse:matrix.org | ||
| ## Key Features | ||
| ### Decentralization and Distribution | ||
| Unlike traditional blockchain systems, this network is not only decentralized but fully distributed. Each participant can run their own node, ensuring there is no single point of failure and making the network extremely resilient. | ||
|
|
||
| .. |development| image:: https://img.shields.io/matrix/synapse-dev:matrix.org?label=development&logo=matrix | ||
| :alt: (discuss development on #synapse-dev:matrix.org) | ||
| :target: https://matrix.to/#/#synapse-dev:matrix.org | ||
| ### Universal Accessibility | ||
| Designed with accessibility in mind, the network is simple to use, even for those who are not crypto experts. The low barriers to entry allow anyone, from individuals to enterprises, to engage with blockchain technology. | ||
|
|
||
| .. |documentation| image:: https://img.shields.io/badge/documentation-%E2%9C%93-success | ||
| :alt: (Rendered documentation on GitHub Pages) | ||
| :target: https://element-hq.github.io/synapse/latest/ | ||
| ### Enterprise-Grade Solutions | ||
| The network provides enterprise-grade solutions for sectors like finance, healthcare, and supply chain. Privacy, scalability, and data security are built into the core, making it ideal for organizations needing secure blockchain infrastructure. | ||
|
|
||
| .. |license| image:: https://img.shields.io/github/license/element-hq/synapse | ||
| :alt: (check license in LICENSE file) | ||
| :target: LICENSE | ||
| ### Community-Driven Ecosystem | ||
| Governance is community-driven, with users participating in decision-making processes. Through decentralized identity (DID) protocols and voting mechanisms, the network is shaped by its users. | ||
|
|
||
| .. |pypi| image:: https://img.shields.io/pypi/v/matrix-synapse | ||
| :alt: (latest version released on PyPi) | ||
| :target: https://pypi.org/project/matrix-synapse | ||
| ## How It Works | ||
| Each user has the opportunity to run their own node, contributing to the health of the network. The distributed nature ensures that no one entity has control over the system, providing true decentralization. The network utilizes state-of-the-art encryption to keep all data secure and private. | ||
|
|
||
| .. |python| image:: https://img.shields.io/pypi/pyversions/matrix-synapse | ||
| :alt: (supported python versions) | ||
| :target: https://pypi.org/project/matrix-synapse | ||
| ## Conclusion | ||
| This fully distributed blockchain network is the key to unlocking the full potential of decentralization. Whether you're an individual or an enterprise, this platform offers an accessible and secure way to participate in the blockchain revolution. |