construct/README.md

# This — is The **Construct**

[![Chat in #construct:zemos.net](https://img.shields.io/matrix/construct:zemos.net.svg?label=Chat%20in%20%23construct%3Azemos.net&logo=matrix&server_fqdn=matrix.org&style=for-the-badge&color=brightgreen)](https://matrix.to/#/#construct:zemos.net) [![](https://img.shields.io/badge/License-BSD-brightgreen.svg?label=%20license&style=for-the-badge&color=brightgreen)]() [![](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?label=contributions&style=for-the-badge&color=brightgreen)]()

### Getting Started

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

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

##### 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.
```

- [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.
Move sections from include README to main README; various updates. 2017-11-30 19:30:19 +01:00			`# This — is The Construct`
move README to markdown. 2015-02-25 03:32:08 +01:00
README: Update room alias in badge. 2020-07-25 11:57:22 +02:00			`[![Chat in #construct:zemos.net](https://img.shields.io/matrix/construct:zemos.net.svg?label=Chat%20in%20%23construct%3Azemos.net&logo=matrix&server_fqdn=matrix.org&style=for-the-badge&color=brightgreen)](https://matrix.to/#/#construct:zemos.net) [![](https://img.shields.io/badge/License-BSD-brightgreen.svg?label=%20license&style=for-the-badge&color=brightgreen)]() [![](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?label=contributions&style=for-the-badge&color=brightgreen)]()`
Simplify README. [ci skip] 2020-04-24 01:09:47 +02:00
doc: Move top-level build section to doc/BUILD. [skip ci] 2019-06-22 02:26:15 +02:00			`### Getting Started`
Update README.md 2017-08-18 00:33:22 +02:00
Simplify readme; add link to docker images. [ci skip] 2022-07-18 01:45:42 +02:00			1. `git clone https://github.com/matrix-construct/construct` or
			`docker pull jevolk/construct:ubuntu-22.04-built`
README: Add download section. 2018-09-14 01:56:58 +02:00
README: Fix doc links; fall prey to the github lockin. [ci skip] 2020-05-29 21:13:41 +02:00			`2. See the [BUILD](https://github.com/matrix-construct/construct/wiki/BUILD) instructions to compile Construct from source.`
Update README; setup instructions. 2018-09-04 07:03:32 +02:00
README: Fix doc links; fall prey to the github lockin. [ci skip] 2020-05-29 21:13:41 +02:00			`3. See the [SETUP](https://github.com/matrix-construct/construct/wiki/SETUP) instructions to run Construct for the first time.`
README: Add blerb on -pitrecdb. 2019-04-17 01:01:28 +02:00
README: Fix doc links; fall prey to the github lockin. [ci skip] 2020-05-29 21:13:41 +02:00			`4. See the [TUNING](https://github.com/matrix-construct/construct/wiki/TUNING) guide to optimize Construct for your deployment.`
doc: Add preliminary TUNING guide. [ci skip] 2020-01-02 20:03:14 +01:00
doc: Move top-level build section to doc/BUILD. [skip ci] 2019-06-22 02:26:15 +02:00			`##### TROUBLESHOOTING`
README: Add blerb on -pitrecdb. 2019-04-17 01:01:28 +02:00
README: Fix doc links; fall prey to the github lockin. [ci skip] 2020-05-29 21:13:41 +02:00			`See the [TROUBLESHOOTING](https://github.com/matrix-construct/construct/wiki/Troubleshooting-problems) guide for solutions to possible`
README: Break out some subsections into doc/ [ci skip] 2019-06-04 06:47:26 +02:00			`problems.`
README: Add blerb on -pitrecdb. 2019-04-17 01:01:28 +02:00
README: Fix doc links; fall prey to the github lockin. [ci skip] 2020-05-29 21:13:41 +02:00			`See the [FREQUENTLY ASKED QUESTIONS](https://github.com/matrix-construct/construct/wiki/FAQ) for answers to the most common`
doc: Start an FAQ. 2020-04-29 04:59:58 +02:00			`perplexities.`

Move sections from include README to main README; various updates. 2017-11-30 19:30:19 +01:00			`## Developers`
move README to markdown. 2015-02-25 03:32:08 +01:00
doc: Improve architecture; add to top readme. [skip ci] 2019-09-16 19:01:43 +02:00			`##### DOCUMENTATION`

tools: fix doxyfile 2020-04-24 04:23:11 +02:00			Generate doxygen using `doxygen ./Doxyfile` the target
README: Tweak format / presentation. [skip ci] 2019-09-16 18:09:47 +02:00			directory is `doc/html`. Browse to `doc/html/index.html`.
build: remove more autotools detritus 2016-03-06 00:49:13 +01:00
Simplify readme; add link to docker images. [ci skip] 2022-07-18 01:45:42 +02:00			`##### DEPLOYMENT ROADMAP`
README: Tweak heading style consistency; roadmap related. [skip ci] 2019-09-19 19:02:57 +02:00
			```
Simplify readme; add link to docker images. [ci skip] 2022-07-18 01:45:42 +02:00			`🛑 Operating a Construct server which is open to public user registration is unsafe. Local users may`
README: Tweak heading style consistency; roadmap related. [skip ci] 2019-09-19 19:02:57 +02:00			`be able to exceed resource limitations and deny service to other users.`
			```
Update README. 2017-12-25 06:41:13 +01:00
README: Clarify deployment scale description based on reported confusion. 2020-04-05 22:41:44 +02:00			`- [x] Personal: Dozens of users. Few default restrictions; higher log output.`
Update README. 2018-04-21 12:24:50 +02:00			`- [ ] Company: Hundreds of users. Moderate default restrictions.`
			`- [ ] Public: Thousands of users. Untrusting configuration defaults.`
Update README. 2017-12-25 06:41:13 +01:00
README: Tweak heading style consistency; roadmap related. [skip ci] 2019-09-19 19:02:57 +02:00			`> 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.`