mirror of https://github.com/matrix-construct/construct synced 2024-12-27 07:54:05 +01:00

No description

Find a file

Jason Volk 191786bc95 Merge branch 'master' of https://github.com/uis246/construct		2022-07-20 21:04:18 -07:00
construct	construct::console: Stream output directly.	2022-07-19 14:26:23 -07: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: Purge some build packages to slim the built image; refine syntax.	2022-07-19 14:26:23 -07:00
include/ircd	ircd::asio: Fix undefined-var-template error; enable -fpch-instantiate-templates.	2022-07-20 18:32:38 -07:00
ircd	ircd::versions: Declare list specialization; noexcept ctors; minor cleanup.	2022-07-20 18:32:38 -07:00
matrix	Fix -flto flag compat erosion w/ gcc.	2022-07-20 12:03:59 -07:00
modules	Merge branch 'rate_limited_resource_handlers' of https://github.com/kamathmanu/construct	2022-07-20 21:00:17 -07:00
nix	nix: move config to separate file	2020-05-13 20:17:51 +01:00
share	share/webapp: Defaulty behavior for empty flows.	2021-08-01 03:11:45 -07:00
tools	configure: Upgrade to gnu++20.	2022-06-19 20:14:22 -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	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
autogen.sh	Move m4 to tools/m4.	2018-09-17 18:52:26 -07:00
configure.ac	Merge branch 'master' of https://github.com/uis246/construct	2022-07-20 21:04:18 -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	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
README.md	README: Add badges for dockerhub and appveyor build. [ci skip]	2022-07-20 20:33:11 -07:00
shell.nix	nix: update shell.nix configureFlags	2020-05-15 22:52:38 +01:00

README.md

This — is The Construct

Getting Started

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

See the BUILD instructions to compile Construct from source.
See the SETUP instructions to run Construct for the first time.
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.

DEPLOYMENT ROADMAP

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