MirrorHub/construct
0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-12-26 07:23:53 +01:00
Code Issues Releases Wiki Activity
No description
14297 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 561a956b2c docker: Alpine-3.16 deck.
2022-07-25 16:22:06 -07:00
construct construct::console: Fix counter possibly preempted by exception. 2022-07-21 13:15:14 -07:00
deps configure: Update rocksdb version default. 2022-07-21 18:28:57 -07:00
doc@a91f7dd0d9 Convert doc/ into wiki submodule. 2020-05-22 20:30:52 -07:00
docker docker: Alpine-3.16 deck. 2022-07-25 16:22:06 -07:00
include/ircd Makefiles: Fix bashisms. (#88) 2022-07-25 14:08:26 -07:00
ircd ircd::ctx: Fixes for boost 1.76 asio API changes. 2022-07-25 12:31:18 -07:00
matrix Fix -flto flag compat erosion w/ gcc. 2022-07-20 12:03:59 -07:00
modules modules/console: Match expression for peer and peer count cmds. 2022-07-24 13:00:03 -07:00
nix nix: move config to separate file 2020-05-13 20:17:51 +01:00
share Makefiles: Fix bashisms. (#88) 2022-07-25 14:08:26 -07:00
tools m4: Always extract major version number in CXX -dumpversion. 2022-07-25 14:08:26 -07:00
.appveyor.yml appveyor: Parameter expansion of the message variable. 2022-06-23 14:11:24 -07:00
.envrc nix: add default.nix and envrc/shell.nix 2020-04-22 04:44:11 +01:00
.gitignore Add post-processed source type extensions to gitignore. 2022-06-17 21:11:53 -07:00
.gitmodules Remove erroneous duplicate submodule for PBC library. Thanks @DanySpin97 2020-12-28 02:00:35 -08:00
.travis.yml
autogen.sh Move m4 to tools/m4. 2018-09-17 18:52:26 -07:00
configure.ac configure: Replace instances of += operator. 2022-07-25 12:41:03 -07:00
default.nix nix: explicitly configure rocksdb in default.nix 2020-05-15 22:50:08 +01:00
Doxyfile tools: fix doxyfile 2020-04-24 04:08:04 +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
LICENSE
Makefile.am ircd: Move matrix application related to derived library. 2019-09-27 19:35:26 -07:00
NEWS.md
README.md README: Move warning out of developers section. [ci skip] 2022-07-21 13:15:14 -07: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

Getting Started

  • git clone https://github.com/matrix-construct/construct
  • docker pull jevolk/construct:ubuntu-22.04-built

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

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

  3. 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.

🛑 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.

Developers

DOCUMENTATION

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

DEPLOYMENT ROADMAP
  • 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.