|
|
||
|---|---|---|
| construct | ||
| deps | ||
| doc@a91f7dd0d9 | ||
| docker | ||
| include/ircd | ||
| ircd | ||
| matrix | ||
| modules | ||
| nix | ||
| share | ||
| tools | ||
| .appveyor.yml | ||
| .envrc | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| autogen.sh | ||
| configure.ac | ||
| default.nix | ||
| Doxyfile | ||
| flake.lock | ||
| flake.nix | ||
| LICENSE | ||
| Makefile.am | ||
| NEWS.md | ||
| README.md | ||
| shell.nix | ||
This — is The Construct
📦 GETTING STARTED
 |
docker pull jevolk/construct:alpine-3.16-base-built |
 |
docker pull jevolk/construct:alpine-3.16-full-built |
 |
docker pull jevolk/construct:ubuntu-22.04-built |
-
git clone https://github.com/matrix-construct/construct
🗒️ INSTRUCTIONS
-
🏗️ BUILD instructions to compile Construct from source.
-
🪛 SETUP instructions to run Construct for the first time.
-
⚡ TUNING guide to optimize Construct for your deployment.
🙋 TROUBLESHOOTING guide for solutions to possible problems.
❓ 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.