MirrorHub/construct
0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-11-21 17:31:21 +01:00
Code Issues Releases Wiki Activity

Add non-interactive section; simplify execute arguments and well-known confusion.

Jason Volk 2023-02-14 00:42:08 -08:00
parent 65d3e268ac
commit 4e400e0676
1 changed files with 25 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
SETUP.md

@ -7,12 +7,7 @@ instructions in [BUILD](https://github.com/matrix-construct/construct/wiki/BUILD
#### NOTES
- We will refer to your server as `host.tld`. For those familiar with matrix:
this is your _origin_ and mxid `@user:host.tld` hostpart. If you delegate
your server's location to something like `matrix.host.tld:1234` we refer to
this as your _servername_.
> Construct clusters all share the same _origin_ but each individual instance
of the daemon has a unique _servername_.
this is your _origin_ and mxid `@user:host.tld` hostpart. Your `well-known` delegation is not relevant here.
- If you built construct yourself as a standalone build you will need to add
the included library directories before executing:
@ -23,8 +18,7 @@ the included library directories before executing:
1. Execute
There are two arguments: `<origin> [servername]`. If the _servername_
argument is missing, the _origin_ will be used for it instead.
There is one argument: `<origin>` described in the notes above (your `host.tld`).
```
bin/construct host.tld
@ -35,15 +29,15 @@ the included library directories before executing:
> Log messages will appear in terminal concluding with notice `IRCd RUN`.
2. Strike ctrl-c on keyboard
> The command-line console will appear.
2. Strike ctrl-c on keyboard for interactive setup or skip to the [non-interactive setup](https://github.com/matrix-construct/construct/wiki/SETUP#non-interactive) section.
> The command-line console will appear for interactive setup.
3. Create a general listener socket by entering the following command:
```
net listen matrix * 8448 privkey.pem cert.pem chain.pem
mod reload m_listen
mod reload m_listen
```
- `matrix` is your name for this listener; you can use any name.
- `*` and `8448` is the local address and port to bind.
@ -68,7 +62,26 @@ to point at Riot's `webapp/` directory by entering the following:
6. Browse to `https://host.tld:8448/`
- Register a user at the console with the command `user register <username> <password>` as registration through clients is disabled by default.
> ❗ **PUBLIC REGISTRATION IS CURRENTLY UNSAFE.** To enable public registration, use the command `conf set ircd.client.register.enable true`
> :stop_sign: **PUBLIC REGISTRATION IS CURRENTLY UNSAFE.** To enable public registration, use the command `conf set ircd.client.register.enable true`
### NON-INTERACTIVE
The listener-socket and web-root as described for interactive setup will instead be configured as environment variables prior to execution.
```
ircd_listen_matrix_host=0.0.0.0
ircd_listen_matrix_port=8448
ircd_listen_matrix_private_key_pem_path=/path/to/my/key
ircd_listen_matrix_certificate_pem_path=/path/to/my/cert
ircd_listen_matrix_certificate_chain_path=/path/to/my/chain
ircd_web_root_path=/path/to/riot-web/webapp/
/bin/construct host.tld
```
> :exclamation: Unlike the interactive setup, this configuration will not be persisted in the database.
> :point_right: Any configuration item within the server can be overridden with an environment variable by replacing any `.` with a `_`.
### ADDENDUM