Fork!
This commit is contained in:
Anatoly Sablin
25
EOL.md
25
EOL.md
@@ -1,25 +0,0 @@
|
||||
# End of Life notice
|
||||
|
||||
This project will no longer be worked on, and no more features/enhancements will be added.
|
||||
|
||||
mxisd was originally created to [help safeguard privacy in Matrix](https://github.com/kamax-matrix/mxisd/wiki/mxisd-and-your-privacy#mxisd-and-your-privacy), and act as a reference for self-hosted infrastructures that required a certain level of compliance, mainly for [EU GDPR](https://eugdpr.org/).
|
||||
|
||||
[Matrix 1.0 has been released](https://matrix.org/blog/2019/06/11/introducing-matrix-1-0-and-the-matrix-org-foundation) which sets a milestone: it sets the level of what is acceptable in terms of privacy and security for the protocol and its reference implementations moving forward.
|
||||
With the help of the community, we wrote a research paper to highlight the current state of privacy: [Notes on privacy and data collection of Matrix.org](https://gist.github.com/maxidorius/5736fd09c9194b7a6dc03b6b8d7220d0).
|
||||
|
||||
We believe the purpose of the mxisd project has now been accomplished - offering an alternative and raising awareness - and we do not see any value going forward with it anymore:
|
||||
- The place of Identity servers in the stack has always been misunderstood and Identity servers [are still considered optional](https://matrix.org/faq#what-is-an-identity-server%3F). Matrix.org also [recommends to not self-host them](https://matrix.org/faq#can-i-run-my-own-identity-server%3F), or even to not use them.
|
||||
- The extent of the privacy leaks in [our research paper](https://gist.github.com/maxidorius/5736fd09c9194b7a6dc03b6b8d7220d0) shows that mxisd cannot significantly make a difference,
|
||||
and most likely will not in the future.
|
||||
- The Matrix.org team [does not share the same views on Privacy and GDPR](https://gist.github.com/maxidorius/5736fd09c9194b7a6dc03b6b8d7220d0#gistcomment-2943323),
|
||||
and has never taken significant interest into the project or our contributions to the Identity Server specification.
|
||||
- The recent change of direction to no longer rely on Identity servers for key behaviours
|
||||
(e.g. [password resets](https://github.com/matrix-org/synapse/pull/5377)) means this project will not maintain its value in the long term.
|
||||
|
||||
Commercial support is still available for bug and security fixes. See [our website](https://www.kamax.io/) for contact information.
|
||||
|
||||
Please visit the [Matrix.org dedicated page](https://matrix.org/docs/projects/try-matrix-now) to find alternative(s) to mxisd.
|
||||
|
||||
---
|
||||
|
||||
**See you in [The Grid](https://gitlab.com/thegridprotocol/home/blob/master/README.md#the-grid) for the next privacy-focused protocol!**
|
||||
37
README.md
37
README.md
@@ -1,6 +1,6 @@
|
||||
mxisd - Federated Matrix Identity Server
|
||||
ma1sd - Federated Matrix Identity Server
|
||||
----------------------------------------
|
||||
|
||||
|
||||
|
||||
- [Overview](#overview)
|
||||
- [Features](#features)
|
||||
@@ -8,18 +8,18 @@ mxisd - Federated Matrix Identity Server
|
||||
- [Getting Started](#getting-started)
|
||||
- [Support](#support)
|
||||
- [Contribute](#contribute)
|
||||
- [Powered by mxisd](#powered-by-mxisd)
|
||||
- [Powered by ma1sd](#powered-by-ma1sd)
|
||||
- [FAQ](#faq)
|
||||
- [Contact](#contact)
|
||||
|
||||
---
|
||||
|
||||
**This project is no longer maintained. See the [End of Life notice](EOL.md#end-of-life-notice) for alternatives.**
|
||||
* This project is a fork of the https://github.com/kamax-matrix/mxisd which has been archived and no longer supported. *
|
||||
|
||||
---
|
||||
|
||||
# Overview
|
||||
mxisd is a Federated Matrix Identity server for self-hosted Matrix infrastructures with [enhanced features](#features).
|
||||
ma1sd is a Federated Matrix Identity server for self-hosted Matrix infrastructures with [enhanced features](#features).
|
||||
As an enhanced Identity service, it implements the [Identity service API](https://matrix.org/docs/spec/identity_service/r0.2.0.html)
|
||||
and several [extra features](#features) that greatly enhance user experience within Matrix.
|
||||
It is the one stop shop for anything regarding Authentication, Directory and Identity management in Matrix built in a
|
||||
@@ -85,31 +85,23 @@ See the [dedicated document](docs/getting-started.md)
|
||||
A basic troubleshooting guide is available [here](docs/troubleshooting.md).
|
||||
|
||||
## Community
|
||||
Over Matrix: [#mxisd:kamax.io](https://matrix.to/#/#mxisd:kamax.io) ([Preview](https://view.matrix.org/room/!NPRUEisLjcaMtHIzDr:kamax.io/))
|
||||
Over Matrix: [#ma1sd:ru-matrix.org](https://matrix.to/#/#ma1sd:ru-matrix.org) ([Preview](https://view.matrix.org/room/!CxwBdgAlaphCARnKTA:ru-matrix.org/))
|
||||
|
||||
## Commercial
|
||||
If you would prefer professional support/custom development for mxisd and/or for Matrix in general, including other open
|
||||
source technologies/products:
|
||||
- Visit our [website](https://www.kamax.io/) to get in touch with us and get a quote.
|
||||
- Come in our general Matrix room: [#kamax-matrix:kamax.io](https://matrix.to/#/#kamax-matrix:kamax.io)
|
||||
Sorry, I cannot provide commercial support (at least now). But always try to help you.
|
||||
|
||||
Don't hesitate to ask about project and feel free to create issues at https://github.com/ma1uta/mxisd
|
||||
|
||||
# Contribute
|
||||
You can contribute as a community member by:
|
||||
- Giving us feedback about your usage of mxisd, even if it seems unimportant or if all is working well!
|
||||
- Opening issues for any weird behaviour or bug. mxisd should feel natural, let us know if it does not!
|
||||
- Giving us feedback about your usage of ma1sd/mxisd, even if it seems unimportant or if all is working well!
|
||||
- Opening issues for any weird behaviour or bug. ma1sd/mxisd should feel natural, let us know if it does not!
|
||||
- Helping us improve the documentation: tell us what is good or not good (in an issue or in Matrix), or make a PR with
|
||||
changes you feel improve the doc.
|
||||
- Contribute code directly: we love contributors! All your contributions will be licensed under AGPLv3.
|
||||
- [Donate!](https://liberapay.com/maximusdor/) Any donation is welcome, regardless how small or big, and will directly
|
||||
be used for the fixed costs and developer time of mxisd.
|
||||
|
||||
You can contribute as an organisation/corporation by:
|
||||
- Get a [support contract](#commercial). This is the best way you can help us as it ensures mxisd is
|
||||
maintained regularly and you get direct access to the support team.
|
||||
- Sponsoring new features or bug fixes. [Get in touch](#contact) so we can discuss it further.
|
||||
|
||||
# Powered by mxisd
|
||||
The following projects use mxisd under the hood for some or all their features. Check them out!
|
||||
# Powered by ma1sd
|
||||
The following projects can use ma1sd under the hood for some or all their features. Check them out!
|
||||
- [matrix-docker-ansible-deploy](https://github.com/spantaleev/matrix-docker-ansible-deploy)
|
||||
- [matrix-register-bot](https://github.com/krombel/matrix-register-bot)
|
||||
|
||||
@@ -118,5 +110,4 @@ See the [dedicated document](docs/faq.md)
|
||||
|
||||
# Contact
|
||||
Get in touch via:
|
||||
- Matrix: [#mxisd:kamax.io](https://matrix.to/#/#mxisd:kamax.io)
|
||||
- Email: see our website: [Kamax.io](https://www.kamax.io)
|
||||
- Matrix: [#ma1sd:ru-matrix.org](https://matrix.to/#/#ma1sd:ru-matrix.org)
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
### Build
|
||||
```bash
|
||||
git clone https://github.com/kamax-matrix/mxisd.git
|
||||
git clone https://github.com/ma1uta/mxisd.git
|
||||
cd mxisd
|
||||
./gradlew build
|
||||
```
|
||||
|
||||
@@ -13,7 +13,7 @@ first basic setup running which relies on you reading the documentation in the r
|
||||
**IMPORTANT**: Be aware that mxisd tries to fit within the current protocol and existing products and basic understanding
|
||||
of the Matrix protocol is required for some advanced features.
|
||||
|
||||
If all fails, come over to [the project room](https://matrix.to/#/#mxisd:kamax.io) and we'll do our best to get you
|
||||
If all fails, come over to [the project room](https://matrix.to/#/#ma1sd:ru-matrix.org) and we'll do our best to get you
|
||||
started and answer questions you might have.
|
||||
|
||||
### What kind of setup is mxisd really designed for?
|
||||
|
||||
@@ -47,7 +47,7 @@ Install via:
|
||||
- [NixOS](install/nixos.md)
|
||||
- [Sources](build.md)
|
||||
|
||||
See the [Latest release](https://github.com/kamax-matrix/mxisd/releases/latest) for links to each.
|
||||
See the [Latest release](https://github.com/ma1uta/ma1sd/releases/latest) for links to each.
|
||||
|
||||
## Configure
|
||||
> **NOTE**: Please view the install instruction for your platform, as this step might be optional or already handled for you.
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
|
||||
** Outdated due to migrating to fork. **
|
||||
|
||||
---
|
||||
|
||||
# Arch Linux package
|
||||
An Arch Linux package in the AUR repos is maintained by [r3pek](https://matrix.to/#/@r3pek:r3pek.org), a community member.
|
||||
See https://aur.archlinux.org/packages/mxisd/
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
- Any distribution that supports Java 8
|
||||
|
||||
## Install
|
||||
1. Download the [latest release](https://github.com/kamax-matrix/mxisd/releases/latest)
|
||||
1. Download the [latest release](https://github.com/ma1uta/mxisd/releases/latest)
|
||||
2. Run:
|
||||
```bash
|
||||
dpkg -i /path/to/downloaded/mxisd.deb
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
|
||||
** Outdated due to migrating to fork. **
|
||||
|
||||
---
|
||||
|
||||
# Docker
|
||||
## Fetch
|
||||
Pull the latest stable image:
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
|
||||
** Outdated due to migrating to fork. **
|
||||
|
||||
---
|
||||
|
||||
# NixOS package
|
||||
mxisd is available as a NixOS package in the official repos.
|
||||
|
||||
|
||||
@@ -58,7 +58,7 @@ Specific placeholders:
|
||||
|
||||
## Templates
|
||||
mxisd comes with a set of builtin templates to easily get started. Those templates can be found
|
||||
[in the repository](https://github.com/kamax-matrix/mxisd/tree/master/src/main/resources/threepids). If you want to use
|
||||
[in the repository](https://github.com/ma1uta/ma1sd/tree/master/src/main/resources/threepids). If you want to use
|
||||
customized templates, we recommend using the builtin templates as a starting point.
|
||||
|
||||
> **NOTE**: The link above point to the latest version of the built-in templates. Those might be different from your
|
||||
|
||||
@@ -135,7 +135,7 @@ This configuration would disable 3PID sessions altogether, preventing users from
|
||||
and any subsequent actions that requires them, like adding them to their profiles.
|
||||
|
||||
This would be used if mxisd is also performing authentication for the Homeserver, typically with synapse and the
|
||||
[REST password provider](https://github.com/kamax-matrix/matrix-synapse-rest-auth), where 3PID mappings would be
|
||||
[REST password provider](https://github.com/ma1uta/matrix-synapse-rest-password-provider), where 3PID mappings would be
|
||||
auto-populated.
|
||||
|
||||
Use the following values to enable this mode:
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# Sample configuration file explaining the minimum required keys to be set to run mxisd
|
||||
# Sample configuration file explaining the minimum required keys to be set to run ma1sd
|
||||
#
|
||||
# For a complete list of options, see https://github.com/kamax-matrix/mxisd/docs/README.md
|
||||
# For a complete list of options, see https://github.com/ma1uta/ma1sd/docs/README.md
|
||||
#
|
||||
# Please follow the Getting Started guide if this is your first time using/configuring mxisd
|
||||
#
|
||||
# -- https://github.com/kamax-matrix/mxisd/blob/master/docs/getting-started.md#getting-started
|
||||
# -- https://github.com/ma1uta/ma1sd/blob/master/docs/getting-started.md#getting-started
|
||||
#
|
||||
|
||||
#######################
|
||||
@@ -58,13 +58,13 @@ storage:
|
||||
# Identity Stores #
|
||||
###################
|
||||
# If you are using synapse standalone and do not have an Identity store,
|
||||
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/stores/synapse.md#synapse-identity-store
|
||||
# see https://github.com/ma1uta/ma1sd/blob/master/docs/stores/synapse.md#synapse-identity-store
|
||||
#
|
||||
# If you would like to integrate with your AD/Samba/LDAP server,
|
||||
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/stores/ldap.md
|
||||
# see https://github.com/ma1uta/ma1sd/blob/master/docs/stores/ldap.md
|
||||
#
|
||||
# For any other Identity store, or to simply discover them,
|
||||
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/stores/README.md
|
||||
# see https://github.com/ma1uta/ma1sd/blob/master/docs/stores/README.md
|
||||
|
||||
|
||||
#################################################
|
||||
@@ -73,10 +73,10 @@ storage:
|
||||
# This is mandatory to deal with anything e-mail related.
|
||||
#
|
||||
# For an introduction to sessions, invites and 3PIDs in general,
|
||||
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/threepids/session/session.md#3pid-sessions
|
||||
# see https://github.com/ma1uta/ma1sd/blob/master/docs/threepids/session/session.md#3pid-sessions
|
||||
#
|
||||
# If you would like to change the content of the notifications,
|
||||
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/threepids/notification/template-generator.md
|
||||
# see https://github.com/ma1uta/ma1sd/blob/master/docs/threepids/notification/template-generator.md
|
||||
#
|
||||
#### E-mail connector
|
||||
threepid:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
Package: mxisd
|
||||
Maintainer: Kamax.io <foss@kamax.io>
|
||||
Homepage: https://github.com/kamax-matrix/mxisd
|
||||
Maintainer: ma1uta <sablintolya@gmail.com>
|
||||
Homepage: https://github.com/ma1uta/mxisd
|
||||
Description: Federated Matrix Identity Server
|
||||
Architecture: all
|
||||
Section: net
|
||||
|
||||
Reference in New Issue
Block a user