MirrorHub
/
construct
mirror of https://github.com/matrix-construct/construct
0
0
Fork 0
Code Issues Releases Wiki Activity
13,490 Commits 1 Branch 23 Tags 42 MiB
C++ 87.4%
JavaScript 4%
M4 2.4%
C 2%
Nix 1.2%
Other 3%
Go to file
Jason Volk 8668c7d418 Remove erroneous duplicate submodule for PBC library. Thanks @DanySpin97 2020-12-28 02:00:35 -08:00
construct construct: Add a millionth tick trap diagnostic. 2020-12-25 08:25:33 -08:00
deps Upgrade to RocksDB 6.6.4. 2020-05-05 19:58:37 -07:00
doc@a91f7dd0d9 Convert doc/ into wiki submodule. 2020-05-22 20:30:52 -07:00
docker docker: Replace lz4 with zstd in ubuntu base. 2020-10-02 03:18:06 -07:00
include/ircd ircd::client: Add write overload for iov arguments. 2020-12-25 07:30:10 -08:00
ircd ircd::ios: Increase default emption frequency. 2020-12-25 08:25:33 -08:00
matrix ircd:Ⓜ️:typing: Drop typing events for rooms w/o local joined user. 2020-12-26 11:55:01 -08:00
modules modules/client/sync: Fix conditions to duplicate state in timeline; improve inconsistencies. 2020-12-26 11:55:01 -08:00
nix nix: move config to separate file 2020-05-13 20:17:51 +01:00
share client: Fix style issues in firefox. 2020-01-21 13:11:03 -08:00
tools ircd::proc: Add basic subprocess interface; ios integration. 2020-10-20 23:20:41 -07:00
.appveyor.yml appveyor: Adjust build matrix. 2020-07-13 21:35:31 -07:00
.envrc nix: add default.nix and envrc/shell.nix 2020-04-22 04:44:11 +01:00
.gitignore ircd: Add target to preprocess PGO data bundled in text form. 2020-11-28 14:35:45 -08:00
.gitmodules Remove erroneous duplicate submodule for PBC library. Thanks @DanySpin97 2020-12-28 02:00:35 -08:00
.travis.yml travis.yml: Travis-CI became useless and inept I guess at some point because 14.04 is not relevant to us. 2018-09-04 23:43:49 -07:00
Doxyfile tools: fix doxyfile 2020-04-24 04:08:04 +01:00
LICENSE Update LICENSE copyright year. 2018-01-10 21:34:21 -08:00
Makefile.am ircd: Move matrix application related to derived library. 2019-09-27 19:35:26 -07:00
NEWS.md Update NEWS. 2017-12-12 14:59:41 -07:00
README.md Update README getting started section. [ci skip] 2020-12-23 22:28:34 -08:00
autogen.sh Move m4 to tools/m4. 2018-09-17 18:52:26 -07:00
configure.ac configure: Init to integer version. 2020-12-15 15:33:57 -08:00
default.nix nix: explicitly configure rocksdb in default.nix 2020-05-15 22:50:08 +01:00
flake.lock nix: init flake 2020-05-13 20:02:40 +01:00
flake.nix nix: move config to separate file 2020-05-13 20:17:51 +01:00
shell.nix nix: update shell.nix configureFlags 2020-05-15 22:52:38 +01:00

README.md

This — is The Construct

Chat in #construct:zemos.net

The community's own Matrix server. It is designed to be fast and highly scalable, and to be developed by volunteer contributors over the internet. This mission strives to make the software easy to understand, modify, audit, and extend.

Matrix is about giving you control over your communication; Construct is about giving you control over Matrix. Your privacy and security matters. We encourage you to contribute new ideas and are liberal in accepting experimental features.

Getting Started

  1. git clone https://github.com/matrix-construct/construct. The latest commit on the master branch should be tagged for release. Please checkout the latest tag to be sure; in case of serious regression, we may delete a tag until it is fixed.

  2. See the BUILD instructions to compile Construct from source.

  3. See the SETUP instructions to run Construct for the first time.

  4. See the TUNING guide to optimize Construct for your deployment.

TROUBLESHOOTING

See the TROUBLESHOOTING guide for solutions to possible problems.

See the FREQUENTLY ASKED QUESTIONS for answers to the most common perplexities.

Developers

DOCUMENTATION

Generate doxygen using doxygen ./Doxyfile the target directory is doc/html. Browse to doc/html/index.html.

ARCHITECTURE GUIDE

See the ARCHITECTURE summary for design choices and things to know when starting out.

DEVELOPMENT STYLE GUIDE

See the STYLE guide for an admittedly tongue-in-cheek lecture on the development approach.

Roadmap

TECHNOLOGY
  • Phase Zero: Core libircd: Utils; Modules; Contexts; JSON; Database; HTTP; etc...
  • Phase One: Matrix Protocol: Core VM; Core modules; Protocol endpoints; etc...
  • Phase Two: Construct Cluster: Kademlia sharding of events; Maymounkov's erasure codes.
DEPLOYMENT
Operating a Construct server which is open to public user registration is unsafe. Local users may
be able to exceed resource limitations and deny service to other users.
  • Personal: Dozens of users. Few default restrictions; higher log output.
  • Company: Hundreds of users. Moderate default restrictions.
  • Public: Thousands of users. Untrusting configuration defaults.

Due to the breadth of the Matrix client/server protocol we can only endorse production use of Construct gradually while local user restrictions are developed. This notice applies to locally registered users connecting with clients, it does not apply to federation.