MirrorHub/construct
0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-12-29 17:04:03 +01:00
Code Issues Releases Wiki Activity
No description
13872 commits 1 branch 23 tags 43 MiB
C++ 87.4%
JavaScript 4%
M4 2.4%
C 2%
Nix 1.2%
Other 3%
Find a file
Jason Volk d733fe8ef9 ircd::simt: Add overloads for scalar types for now.
2022-06-17 21:11:53 -07:00
construct construct::console: Improve interrupt mask toggling for sleep. 2021-04-22 12:27:57 -07:00
deps
doc@a91f7dd0d9
docker docker: Replace lz4 with zstd in ubuntu base. 2020-10-02 03:18:06 -07:00
include/ircd ircd::simt: Add overloads for scalar types for now. 2022-06-17 21:11:53 -07:00
ircd ircd:🆑 Add shlib path conf. 2022-06-17 21:11:53 -07:00
matrix ircd:Ⓜ️:homeserver: Fix net_dns_cache.so loading w/ -noautomod. 2022-06-17 21:11:52 -07:00
modules ircd::db: Add SST scan interface w/ console suite. 2022-06-17 21:11:52 -07:00
nix
share share/webapp: Defaulty behavior for empty flows. 2021-08-01 03:11:45 -07:00
tools ircd::proc: Add basic subprocess interface; ios integration. 2020-10-20 23:20:41 -07:00
.appveyor.yml
.envrc
.gitignore Add .spv to .gitignore for SPIR-V bytecode generations. 2022-06-17 21:11:52 -07:00
.gitmodules Remove erroneous duplicate submodule for PBC library. Thanks @DanySpin97 2020-12-28 02:00:35 -08:00
.travis.yml
autogen.sh
configure.ac configure: Specifics for clang-13. 2022-06-17 21:11:53 -07:00
default.nix
Doxyfile
flake.lock
flake.nix
LICENSE
Makefile.am
NEWS.md
README.md Update README getting started section. [ci skip] 2020-12-23 22:28:34 -08:00
shell.nix

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.