mirror of
https://github.com/matrix-construct/construct
synced 2024-11-15 14:31:11 +01:00
70 lines
3.4 KiB
Markdown
70 lines
3.4 KiB
Markdown
# This — is The **Construct**
|
|
|
|
[](https://matrix.to/#/#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](https://github.com/matrix-construct/construct/wiki/BUILD) instructions to compile Construct from source.
|
|
|
|
3. See the [SETUP](https://github.com/matrix-construct/construct/wiki/SETUP) instructions to run Construct for the first time.
|
|
|
|
4. See the [TUNING](https://github.com/matrix-construct/construct/wiki/TUNING) guide to optimize Construct for your deployment.
|
|
|
|
##### TROUBLESHOOTING
|
|
|
|
See the [TROUBLESHOOTING](https://github.com/matrix-construct/construct/wiki/Troubleshooting-problems) guide for solutions to possible
|
|
problems.
|
|
|
|
See the [FREQUENTLY ASKED QUESTIONS](https://github.com/matrix-construct/construct/wiki/FAQ) 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](https://github.com/matrix-construct/construct/wiki/ARCHITECTURE) summary for design choices and
|
|
things to know when starting out.
|
|
|
|
##### DEVELOPMENT STYLE GUIDE
|
|
|
|
See the [STYLE](https://github.com/matrix-construct/construct/wiki/STYLE) guide for an admittedly tongue-in-cheek lecture on
|
|
the development approach.
|
|
|
|
## Roadmap
|
|
|
|
##### TECHNOLOGY
|
|
|
|
- [x] Phase Zero: **Core libircd**: Utils; Modules; Contexts; JSON; Database; HTTP; etc...
|
|
- [x] 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.
|
|
```
|
|
|
|
- [x] **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.
|