aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKegsay <kegan@matrix.org>2020-07-02 17:11:33 +0100
committerGitHub <noreply@github.com>2020-07-02 17:11:33 +0100
commit9c1f38621c4d787761092bc841e06ca424fbbf35 (patch)
treec7663e2f1f0af6414d1d66567265f5158360d8f2 /docs
parent4c1e6597c0ea82f5390b73f35036db58e65542cc (diff)
Remove publicroomsapi (#1176)
* Remove all of publicroomsapi * Remove references to publicroomsapi * Remove doc references to publicroomsapi
Diffstat (limited to 'docs')
-rw-r--r--docs/INSTALL.md32
-rw-r--r--docs/WIRING-Current.md50
2 files changed, 35 insertions, 47 deletions
diff --git a/docs/INSTALL.md b/docs/INSTALL.md
index b4c81a42..c9735180 100644
--- a/docs/INSTALL.md
+++ b/docs/INSTALL.md
@@ -108,7 +108,7 @@ Assuming that Postgres 9.5 (or later) is installed:
* Create the component databases:
```bash
- for i in account device mediaapi syncapi roomserver serverkey federationsender publicroomsapi appservice naffka; do
+ for i in account device mediaapi syncapi roomserver serverkey federationsender currentstate appservice naffka; do
sudo -u postgres createdb -O dendrite dendrite_$i
done
```
@@ -176,17 +176,17 @@ The following contains scripts which will run all the required processes in orde
| | :7774
| |
| |
- | | /directory +----------------------------------+
- | | +--------->| dendrite-public-rooms-api-server |<========++
- | | | +----------------------------------+ ||
- | | | :7775 | ||
- | | | +<-----------+ ||
- | | | | ||
- | | | /sync +--------------------------+ ||
+ | |
+ | |
+ | |
+ | |
+ | |
+ | |
+ | | /sync +--------------------------+
| | +--------->| dendrite-sync-api-server |<================++
- | | | | +--------------------------+ ||
- | | | | :7773 | ^^ ||
-Matrix +------------------+ | | | | || client_data ||
+ | | | +--------------------------+ ||
+ | | | :7773 | ^^ ||
+Matrix +------------------+ | | | || client_data ||
Clients --->| client-api-proxy |-------+ +<-----------+ ++=============++ ||
+------------------+ | | | || ||
:8008 | | CS API +----------------------------+ || ||
@@ -232,7 +232,6 @@ your client at `http://localhost:8008`.
--client-api-server-url "http://localhost:7771" \
--sync-api-server-url "http://localhost:7773" \
--media-api-server-url "http://localhost:7774" \
---public-rooms-api-server-url "http://localhost:7775" \
```
### Federation proxy
@@ -282,15 +281,6 @@ order to upload and retrieve media.
./bin/dendrite-media-api-server --config dendrite.yaml
```
-### Public room server
-
-This implements `/directory` requests. Clients talk to this via the proxy
-in order to retrieve room directory listings.
-
-```bash
-./bin/dendrite-public-rooms-api-server --config dendrite.yaml
-```
-
### Federation API server
This implements federation requests. Servers talk to this via the proxy in
diff --git a/docs/WIRING-Current.md b/docs/WIRING-Current.md
index ec539d4e..b74f341e 100644
--- a/docs/WIRING-Current.md
+++ b/docs/WIRING-Current.md
@@ -9,23 +9,22 @@ a request/response model like HTTP or RPC. Therefore, components can expose "int
Note in Monolith mode these are actually direct function calls and are not serialised HTTP requests.
```
- Tier 1 Sync PublicRooms FederationAPI ClientAPI MediaAPI
-Public Facing | .-----1------` | | | | | | | | |
- 2 | .-------3-----------------` | | | `--------|-|-|-|--11--------------------.
- | | | .--------4----------------------------------` | | | |
- | | | | .---5-----------` | | | | | |
- | | | | | .---6----------------------------` | | |
- | | | | | | | .-----7----------` | |
- | | | | | | 8 | | 10 |
- | | | | | | | | `---9----. | |
- V V V V V V V V V V V
+ Tier 1 Sync FederationAPI ClientAPI MediaAPI
+Public Facing | | | | | | | | | |
+ 2 .-------3-----------------` | | | `--------|-|-|-|--11--------------------.
+ | | .--------4----------------------------------` | | | |
+ | | | .---5-----------` | | | | | |
+ | | | | .---6----------------------------` | | |
+ | | | | | | .-----7----------` | |
+ | | | | | 8 | | 10 |
+ | | | | | | | `---9----. | |
+ V V V V V V V V V V
Tier 2 Roomserver EDUServer FedSender AppService KeyServer ServerKeyAPI
Internal only | `------------------------12----------^ ^
`------------------------------------------------------------13----------`
Client ---> Server
```
-- 1 (PublicRooms -> Roomserver): Calculating current auth for changing visibility
- 2 (Sync -> Roomserver): When making backfill requests
- 3 (FedAPI -> Roomserver): Calculating (prev/auth events) and sending new events, processing backfill/state/state_ids requests
- 4 (ClientAPI -> Roomserver): Calculating (prev/auth events) and sending new events, processing /state requests
@@ -46,20 +45,20 @@ In addition to this, all public facing components (Tier 1) talk to the `UserAPI`
```
.----1--------------------------------------------.
V |
- Tier 1 Sync PublicRooms FederationAPI ClientAPI MediaAPI
-Public Facing ^ ^ ^ ^
- | | | |
- 2 | | |
+ Tier 1 Sync FederationAPI ClientAPI MediaAPI
+Public Facing ^ ^ ^
+ | | |
+ 2 | |
| `-3------------. |
- | | | |
- | | | |
- | .------4------` | |
- | | .--------5-----|------------------------------`
- | | | |
+ | | |
+ | | |
+ | | |
+ | .--------4-----|------------------------------`
+ | | |
Tier 2 Roomserver EDUServer FedSender AppService KeyServer ServerKeyAPI
Internal only | | ^ ^
- | `-----6----------` |
- `--------------------7--------`
+ | `-----5----------` |
+ `--------------------6--------`
Producer ----> Consumer
@@ -67,7 +66,6 @@ Producer ----> Consumer
- 1 (ClientAPI -> Sync): For tracking account data
- 2 (Roomserver -> Sync): For all data to send to clients
- 3 (EDUServer -> Sync): For typing/send-to-device data to send to clients
-- 4 (Roomserver -> PublicRooms): For tracking the current room name/topic/joined count/etc.
-- 5 (Roomserver -> ClientAPI): For tracking memberships for profile updates.
-- 6 (EDUServer -> FedSender): For sending EDUs over federation
-- 7 (Roomserver -> FedSender): For sending PDUs over federation, for tracking joined hosts.
+- 4 (Roomserver -> ClientAPI): For tracking memberships for profile updates.
+- 5 (EDUServer -> FedSender): For sending EDUs over federation
+- 6 (Roomserver -> FedSender): For sending PDUs over federation, for tracking joined hosts.