Replace references to the repository
This commit is contained in:
parent
6e6c3de0a6
commit
891950f7b6
2
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
vendored
2
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
vendored
@ -6,7 +6,7 @@ about: Suggest an idea for this project
|
|||||||
|
|
||||||
<!--
|
<!--
|
||||||
Please do not open feature requests for missing parts of the Matrix specification.
|
Please do not open feature requests for missing parts of the Matrix specification.
|
||||||
We are tracking those features under https://github.com/matrix-org/dendrite/issues?q=is%3Aissue+is%3Aopen+label%3Aare-we-synapse-yet
|
We are tracking those features under https://github.com/element-hq/dendrite/issues?q=is%3Aissue+is%3Aopen+label%3Aare-we-synapse-yet
|
||||||
-->
|
-->
|
||||||
|
|
||||||
**Description:**
|
**Description:**
|
||||||
|
34
.github/workflows/dendrite.yml
vendored
34
.github/workflows/dendrite.yml
vendored
@ -5,14 +5,14 @@ on:
|
|||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
paths:
|
paths:
|
||||||
- '**.go' # only execute on changes to go files
|
- "**.go" # only execute on changes to go files
|
||||||
- 'go.sum' # or dependency updates
|
- "go.sum" # or dependency updates
|
||||||
- '.github/workflows/**' # or workflow changes
|
- ".github/workflows/**" # or workflow changes
|
||||||
pull_request:
|
pull_request:
|
||||||
paths:
|
paths:
|
||||||
- '**.go'
|
- "**.go"
|
||||||
- 'go.sum' # or dependency updates
|
- "go.sum" # or dependency updates
|
||||||
- '.github/workflows/**'
|
- ".github/workflows/**"
|
||||||
release:
|
release:
|
||||||
types: [published]
|
types: [published]
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
@ -33,7 +33,7 @@ jobs:
|
|||||||
- name: Install Go
|
- name: Install Go
|
||||||
uses: actions/setup-go@v4
|
uses: actions/setup-go@v4
|
||||||
with:
|
with:
|
||||||
go-version-file: 'go.mod'
|
go-version-file: "go.mod"
|
||||||
cache: true
|
cache: true
|
||||||
|
|
||||||
- name: Install Node
|
- name: Install Node
|
||||||
@ -72,7 +72,7 @@ jobs:
|
|||||||
- name: Install Go
|
- name: Install Go
|
||||||
uses: actions/setup-go@v4
|
uses: actions/setup-go@v4
|
||||||
with:
|
with:
|
||||||
go-version-file: 'go.mod'
|
go-version-file: "go.mod"
|
||||||
- name: golangci-lint
|
- name: golangci-lint
|
||||||
uses: golangci/golangci-lint-action@v3
|
uses: golangci/golangci-lint-action@v3
|
||||||
|
|
||||||
@ -108,7 +108,7 @@ jobs:
|
|||||||
- name: Setup go
|
- name: Setup go
|
||||||
uses: actions/setup-go@v4
|
uses: actions/setup-go@v4
|
||||||
with:
|
with:
|
||||||
go-version-file: 'go.mod'
|
go-version-file: "go.mod"
|
||||||
- uses: actions/cache@v4
|
- uses: actions/cache@v4
|
||||||
# manually set up caches, as they otherwise clash with different steps using setup-go with cache=true
|
# manually set up caches, as they otherwise clash with different steps using setup-go with cache=true
|
||||||
with:
|
with:
|
||||||
@ -145,7 +145,7 @@ jobs:
|
|||||||
- name: Setup go
|
- name: Setup go
|
||||||
uses: actions/setup-go@v4
|
uses: actions/setup-go@v4
|
||||||
with:
|
with:
|
||||||
go-version-file: 'go.mod'
|
go-version-file: "go.mod"
|
||||||
- uses: actions/cache@v4
|
- uses: actions/cache@v4
|
||||||
with:
|
with:
|
||||||
path: |
|
path: |
|
||||||
@ -178,7 +178,7 @@ jobs:
|
|||||||
- name: Setup Go
|
- name: Setup Go
|
||||||
uses: actions/setup-go@v4
|
uses: actions/setup-go@v4
|
||||||
with:
|
with:
|
||||||
go-version-file: 'go.mod'
|
go-version-file: "go.mod"
|
||||||
- uses: actions/cache@v4
|
- uses: actions/cache@v4
|
||||||
with:
|
with:
|
||||||
path: |
|
path: |
|
||||||
@ -241,7 +241,7 @@ jobs:
|
|||||||
- name: Setup go
|
- name: Setup go
|
||||||
uses: actions/setup-go@v4
|
uses: actions/setup-go@v4
|
||||||
with:
|
with:
|
||||||
go-version-file: 'go.mod'
|
go-version-file: "go.mod"
|
||||||
- name: Set up gotestfmt
|
- name: Set up gotestfmt
|
||||||
uses: gotesttools/gotestfmt-action@v2
|
uses: gotesttools/gotestfmt-action@v2
|
||||||
with:
|
with:
|
||||||
@ -279,7 +279,7 @@ jobs:
|
|||||||
- name: Setup go
|
- name: Setup go
|
||||||
uses: actions/setup-go@v4
|
uses: actions/setup-go@v4
|
||||||
with:
|
with:
|
||||||
go-version-file: 'go.mod'
|
go-version-file: "go.mod"
|
||||||
cache: true
|
cache: true
|
||||||
- uses: actions/cache@v4
|
- uses: actions/cache@v4
|
||||||
with:
|
with:
|
||||||
@ -309,7 +309,7 @@ jobs:
|
|||||||
- name: Setup go
|
- name: Setup go
|
||||||
uses: actions/setup-go@v4
|
uses: actions/setup-go@v4
|
||||||
with:
|
with:
|
||||||
go-version-file: 'go.mod'
|
go-version-file: "go.mod"
|
||||||
cache: true
|
cache: true
|
||||||
- uses: actions/cache@v4
|
- uses: actions/cache@v4
|
||||||
with:
|
with:
|
||||||
@ -474,7 +474,7 @@ jobs:
|
|||||||
upgrade_test_direct,
|
upgrade_test_direct,
|
||||||
sytest,
|
sytest,
|
||||||
complement,
|
complement,
|
||||||
integration
|
integration,
|
||||||
]
|
]
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
if: ${{ !cancelled() }} # Run this even if prior jobs were skipped
|
if: ${{ !cancelled() }} # Run this even if prior jobs were skipped
|
||||||
@ -490,8 +490,8 @@ jobs:
|
|||||||
packages: write
|
packages: write
|
||||||
contents: read
|
contents: read
|
||||||
security-events: write # To upload Trivy sarif files
|
security-events: write # To upload Trivy sarif files
|
||||||
if: github.repository == 'matrix-org/dendrite' && github.ref_name == 'main'
|
if: github.repository == 'element-hq/dendrite' && github.ref_name == 'main'
|
||||||
needs: [integration-tests-done]
|
needs: [integration-tests-done]
|
||||||
uses: matrix-org/dendrite/.github/workflows/docker.yml@main
|
uses: element-hq/dendrite/.github/workflows/docker.yml@main
|
||||||
secrets:
|
secrets:
|
||||||
DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
|
DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
|
||||||
|
12
README.md
12
README.md
@ -1,6 +1,6 @@
|
|||||||
# Dendrite
|
# Dendrite
|
||||||
|
|
||||||
[![Build status](https://github.com/matrix-org/dendrite/actions/workflows/dendrite.yml/badge.svg?event=push)](https://github.com/matrix-org/dendrite/actions/workflows/dendrite.yml) [![Dendrite](https://img.shields.io/matrix/dendrite:matrix.org.svg?label=%23dendrite%3Amatrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#dendrite:matrix.org) [![Dendrite Dev](https://img.shields.io/matrix/dendrite-dev:matrix.org.svg?label=%23dendrite-dev%3Amatrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#dendrite-dev:matrix.org)
|
[![Build status](https://github.com/element-hq/dendrite/actions/workflows/dendrite.yml/badge.svg?event=push)](https://github.com/element-hq/dendrite/actions/workflows/dendrite.yml) [![Dendrite](https://img.shields.io/matrix/dendrite:matrix.org.svg?label=%23dendrite%3Amatrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#dendrite:matrix.org) [![Dendrite Dev](https://img.shields.io/matrix/dendrite-dev:matrix.org.svg?label=%23dendrite-dev%3Amatrix.org&logo=matrix&server_fqdn=matrix.org)](https://matrix.to/#/#dendrite-dev:matrix.org)
|
||||||
|
|
||||||
Dendrite is a second-generation Matrix homeserver written in Go.
|
Dendrite is a second-generation Matrix homeserver written in Go.
|
||||||
It intends to provide an **efficient**, **reliable** and **scalable** alternative to [Synapse](https://github.com/matrix-org/synapse):
|
It intends to provide an **efficient**, **reliable** and **scalable** alternative to [Synapse](https://github.com/matrix-org/synapse):
|
||||||
@ -47,7 +47,7 @@ For a usable federating Dendrite deployment, you will also need:
|
|||||||
Also recommended are:
|
Also recommended are:
|
||||||
|
|
||||||
- A PostgreSQL database engine, which will perform better than SQLite with many users and/or larger rooms
|
- A PostgreSQL database engine, which will perform better than SQLite with many users and/or larger rooms
|
||||||
- A reverse proxy server, such as nginx, configured [like this sample](https://github.com/matrix-org/dendrite/blob/main/docs/nginx/dendrite-sample.conf)
|
- A reverse proxy server, such as nginx, configured [like this sample](https://github.com/element-hq/dendrite/blob/main/docs/nginx/dendrite-sample.conf)
|
||||||
|
|
||||||
The [Federation Tester](https://federationtester.matrix.org) can be used to verify your deployment.
|
The [Federation Tester](https://federationtester.matrix.org) can be used to verify your deployment.
|
||||||
|
|
||||||
@ -58,7 +58,7 @@ If you wish to build a fully-federating Dendrite instance, see [the Installation
|
|||||||
The following instructions are enough to get Dendrite started as a non-federating test deployment using self-signed certificates and SQLite databases:
|
The following instructions are enough to get Dendrite started as a non-federating test deployment using self-signed certificates and SQLite databases:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ git clone https://github.com/matrix-org/dendrite
|
$ git clone https://github.com/element-hq/dendrite
|
||||||
$ cd dendrite
|
$ cd dendrite
|
||||||
$ go build -o bin/ ./cmd/...
|
$ go build -o bin/ ./cmd/...
|
||||||
|
|
||||||
@ -116,12 +116,12 @@ This means Dendrite supports amongst others:
|
|||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
We would be grateful for any help on issues marked as
|
We would be grateful for any help on issues marked as
|
||||||
[Are We Synapse Yet](https://github.com/matrix-org/dendrite/labels/are-we-synapse-yet). These issues
|
[Are We Synapse Yet](https://github.com/element-hq/dendrite/labels/are-we-synapse-yet). These issues
|
||||||
all have related Sytests which need to pass in order for the issue to be closed. Once you've written your
|
all have related Sytests which need to pass in order for the issue to be closed. Once you've written your
|
||||||
code, you can quickly run Sytest to ensure that the test names are now passing.
|
code, you can quickly run Sytest to ensure that the test names are now passing.
|
||||||
|
|
||||||
If you're new to the project, see our
|
If you're new to the project, see our
|
||||||
[Contributing page](https://matrix-org.github.io/dendrite/development/contributing) to get up to speed, then
|
[Contributing page](https://matrix-org.github.io/dendrite/development/contributing) to get up to speed, then
|
||||||
look for [Good First Issues](https://github.com/matrix-org/dendrite/labels/good%20first%20issue). If you're
|
look for [Good First Issues](https://github.com/element-hq/dendrite/labels/good%20first%20issue). If you're
|
||||||
familiar with the project, look for [Help Wanted](https://github.com/matrix-org/dendrite/labels/help-wanted)
|
familiar with the project, look for [Help Wanted](https://github.com/element-hq/dendrite/labels/help-wanted)
|
||||||
issues.
|
issues.
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
This component roughly corresponds to "Client Room Send" and "Client Sync" on [the WIRING diagram](https://github.com/matrix-org/dendrite/blob/master/WIRING.md).
|
This component roughly corresponds to "Client Room Send" and "Client Sync" on [the WIRING diagram](https://github.com/element-hq/dendrite/blob/master/WIRING.md).
|
||||||
This component produces multiple binaries.
|
This component produces multiple binaries.
|
||||||
|
|
||||||
## Internals
|
## Internals
|
||||||
|
@ -188,14 +188,13 @@ client_api:
|
|||||||
recaptcha_public_key: ""
|
recaptcha_public_key: ""
|
||||||
recaptcha_private_key: ""
|
recaptcha_private_key: ""
|
||||||
recaptcha_bypass_secret: ""
|
recaptcha_bypass_secret: ""
|
||||||
|
|
||||||
# To use hcaptcha.com instead of ReCAPTCHA, set the following parameters, otherwise just keep them empty.
|
# To use hcaptcha.com instead of ReCAPTCHA, set the following parameters, otherwise just keep them empty.
|
||||||
# recaptcha_siteverify_api: "https://hcaptcha.com/siteverify"
|
# recaptcha_siteverify_api: "https://hcaptcha.com/siteverify"
|
||||||
# recaptcha_api_js_url: "https://js.hcaptcha.com/1/api.js"
|
# recaptcha_api_js_url: "https://js.hcaptcha.com/1/api.js"
|
||||||
# recaptcha_form_field: "h-captcha-response"
|
# recaptcha_form_field: "h-captcha-response"
|
||||||
# recaptcha_sitekey_class: "h-captcha"
|
# recaptcha_sitekey_class: "h-captcha"
|
||||||
|
|
||||||
|
|
||||||
# TURN server information that this homeserver should send to clients.
|
# TURN server information that this homeserver should send to clients.
|
||||||
turn:
|
turn:
|
||||||
turn_user_lifetime: "5m"
|
turn_user_lifetime: "5m"
|
||||||
@ -337,7 +336,7 @@ user_api:
|
|||||||
# worker_count: 8
|
# worker_count: 8
|
||||||
|
|
||||||
# Configuration for Opentracing.
|
# Configuration for Opentracing.
|
||||||
# See https://github.com/matrix-org/dendrite/tree/master/docs/tracing for information on
|
# See https://github.com/element-hq/dendrite/tree/master/docs/tracing for information on
|
||||||
# how this works and how to set it up.
|
# how this works and how to set it up.
|
||||||
tracing:
|
tracing:
|
||||||
enabled: false
|
enabled: false
|
||||||
|
16
docs/FAQ.md
16
docs/FAQ.md
@ -18,13 +18,13 @@ Mostly, although there are still bugs and missing features. If you are a confide
|
|||||||
|
|
||||||
## Is Dendrite feature-complete?
|
## Is Dendrite feature-complete?
|
||||||
|
|
||||||
No, although a good portion of the Matrix specification has been implemented. Mostly missing are client features - see the [readme](https://github.com/matrix-org/dendrite/blob/main/README.md) at the root of the repository for more information.
|
No, although a good portion of the Matrix specification has been implemented. Mostly missing are client features - see the [readme](https://github.com/element-hq/dendrite/blob/main/README.md) at the root of the repository for more information.
|
||||||
|
|
||||||
## Why doesn't Dendrite have "x" yet?
|
## Why doesn't Dendrite have "x" yet?
|
||||||
|
|
||||||
Dendrite development is currently supported by a small team of developers and due to those limited resources, the majority of the effort is focused on getting Dendrite to be
|
Dendrite development is currently supported by a small team of developers and due to those limited resources, the majority of the effort is focused on getting Dendrite to be
|
||||||
specification complete. If there are major features you're requesting (e.g. new administration endpoints), we'd like to strongly encourage you to join the community in supporting
|
specification complete. If there are major features you're requesting (e.g. new administration endpoints), we'd like to strongly encourage you to join the community in supporting
|
||||||
the development efforts through [contributing](./development/CONTRIBUTING.md).
|
the development efforts through [contributing](./development/CONTRIBUTING.md).
|
||||||
|
|
||||||
## Is there a migration path from Synapse to Dendrite?
|
## Is there a migration path from Synapse to Dendrite?
|
||||||
|
|
||||||
@ -37,7 +37,7 @@ No, Dendrite has a very different database schema to Synapse and the two are not
|
|||||||
|
|
||||||
## Can I configure which port Dendrite listens on?
|
## Can I configure which port Dendrite listens on?
|
||||||
|
|
||||||
Yes, use the cli flag `-http-bind-address`.
|
Yes, use the cli flag `-http-bind-address`.
|
||||||
|
|
||||||
## I've installed Dendrite but federation isn't working
|
## I've installed Dendrite but federation isn't working
|
||||||
|
|
||||||
@ -130,9 +130,9 @@ We don't officially support this or any other dedicated media storage solutions.
|
|||||||
|
|
||||||
## Is there an upgrade guide for Dendrite?
|
## Is there an upgrade guide for Dendrite?
|
||||||
|
|
||||||
Run a newer docker image. We don't officially support deployments other than Docker.
|
Run a newer docker image. We don't officially support deployments other than Docker.
|
||||||
Most of the time you should be able to just
|
Most of the time you should be able to just
|
||||||
- stop
|
- stop
|
||||||
- replace binary
|
- replace binary
|
||||||
- start
|
- start
|
||||||
|
|
||||||
|
@ -10,7 +10,7 @@ plugins:
|
|||||||
- jekyll-feed
|
- jekyll-feed
|
||||||
aux_links:
|
aux_links:
|
||||||
"GitHub":
|
"GitHub":
|
||||||
- "//github.com/matrix-org/dendrite"
|
- "//github.com/element-hq/dendrite"
|
||||||
aux_links_new_tab: true
|
aux_links_new_tab: true
|
||||||
sass:
|
sass:
|
||||||
sass_dir: _sass
|
sass_dir: _sass
|
||||||
|
@ -101,7 +101,7 @@ We also have unit tests which we run via:
|
|||||||
DENDRITE_TEST_SKIP_NODB=1 go test --race ./...
|
DENDRITE_TEST_SKIP_NODB=1 go test --race ./...
|
||||||
```
|
```
|
||||||
|
|
||||||
This only runs SQLite database tests. If you wish to execute Postgres tests as well, you'll either need to
|
This only runs SQLite database tests. If you wish to execute Postgres tests as well, you'll either need to
|
||||||
have Postgres installed locally (`createdb` will be used) or have a remote/containerized Postgres instance
|
have Postgres installed locally (`createdb` will be used) or have a remote/containerized Postgres instance
|
||||||
available.
|
available.
|
||||||
|
|
||||||
@ -119,7 +119,7 @@ code is functioning as intended is great, and to ensure that we will find out qu
|
|||||||
in the future if any regressions happen.
|
in the future if any regressions happen.
|
||||||
|
|
||||||
We use the standard [Go testing package](https://gobyexample.com/testing) for this,
|
We use the standard [Go testing package](https://gobyexample.com/testing) for this,
|
||||||
alongside some helper functions in our own [`test` package](https://pkg.go.dev/github.com/matrix-org/dendrite/test).
|
alongside some helper functions in our own [`test` package](https://pkg.go.dev/github.com/element-hq/dendrite/test).
|
||||||
|
|
||||||
## Continuous integration
|
## Continuous integration
|
||||||
|
|
||||||
@ -131,7 +131,7 @@ test suites ([Complement](https://github.com/matrix-org/complement) and
|
|||||||
[SyTest](https://github.com/matrix-org/sytest)).
|
[SyTest](https://github.com/matrix-org/sytest)).
|
||||||
|
|
||||||
You can see the progress of any CI jobs at the bottom of the Pull Request page, or by
|
You can see the progress of any CI jobs at the bottom of the Pull Request page, or by
|
||||||
looking at the [Actions](https://github.com/matrix-org/dendrite/actions) tab of the Dendrite
|
looking at the [Actions](https://github.com/element-hq/dendrite/actions) tab of the Dendrite
|
||||||
repository.
|
repository.
|
||||||
|
|
||||||
We generally won't accept a submission unless all of the CI jobs are passing. We
|
We generally won't accept a submission unless all of the CI jobs are passing. We
|
||||||
@ -152,7 +152,7 @@ significant amount of CPU and RAM.
|
|||||||
|
|
||||||
Once the code builds, run [Sytest](https://github.com/matrix-org/sytest)
|
Once the code builds, run [Sytest](https://github.com/matrix-org/sytest)
|
||||||
according to the guide in
|
according to the guide in
|
||||||
[docs/development/sytest.md](https://github.com/matrix-org/dendrite/blob/main/docs/development/sytest.md#using-a-sytest-docker-image)
|
[docs/development/sytest.md](https://github.com/element-hq/dendrite/blob/main/docs/development/sytest.md#using-a-sytest-docker-image)
|
||||||
so you can see whether something is being broken and whether there are newly
|
so you can see whether something is being broken and whether there are newly
|
||||||
passing tests.
|
passing tests.
|
||||||
|
|
||||||
@ -162,17 +162,17 @@ tests.
|
|||||||
## Picking things to do
|
## Picking things to do
|
||||||
|
|
||||||
If you're new then feel free to pick up an issue labelled [good first
|
If you're new then feel free to pick up an issue labelled [good first
|
||||||
issue](https://github.com/matrix-org/dendrite/labels/good%20first%20issue).
|
issue](https://github.com/element-hq/dendrite/labels/good%20first%20issue).
|
||||||
These should be well-contained, small pieces of work that can be picked up to
|
These should be well-contained, small pieces of work that can be picked up to
|
||||||
help you get familiar with the code base.
|
help you get familiar with the code base.
|
||||||
|
|
||||||
Once you're comfortable with hacking on Dendrite there are issues labelled as
|
Once you're comfortable with hacking on Dendrite there are issues labelled as
|
||||||
[help wanted](https://github.com/matrix-org/dendrite/labels/help-wanted),
|
[help wanted](https://github.com/element-hq/dendrite/labels/help-wanted),
|
||||||
these are often slightly larger or more complicated pieces of work but are
|
these are often slightly larger or more complicated pieces of work but are
|
||||||
hopefully nonetheless fairly well-contained.
|
hopefully nonetheless fairly well-contained.
|
||||||
|
|
||||||
We ask people who are familiar with Dendrite to leave the [good first
|
We ask people who are familiar with Dendrite to leave the [good first
|
||||||
issue](https://github.com/matrix-org/dendrite/labels/good%20first%20issue)
|
issue](https://github.com/element-hq/dendrite/labels/good%20first%20issue)
|
||||||
issues so that there is always a way for new people to come and get involved.
|
issues so that there is always a way for new people to come and get involved.
|
||||||
|
|
||||||
## Getting help
|
## Getting help
|
||||||
|
@ -28,7 +28,7 @@ go build -o bin/ ./cmd/...
|
|||||||
```
|
```
|
||||||
|
|
||||||
If you are fixing an issue marked with
|
If you are fixing an issue marked with
|
||||||
[Are We Synapse Yet](https://github.com/matrix-org/dendrite/labels/are-we-synapse-yet)
|
[Are We Synapse Yet](https://github.com/element-hq/dendrite/labels/are-we-synapse-yet)
|
||||||
then there will be a list of Sytests that you should add to the whitelist when you
|
then there will be a list of Sytests that you should add to the whitelist when you
|
||||||
have fixed that issue. This MUST be included in your PR to ensure that the issue
|
have fixed that issue. This MUST be included in your PR to ensure that the issue
|
||||||
is fully resolved.
|
is fully resolved.
|
||||||
|
@ -77,8 +77,8 @@ therefore does not need this to be manually installed.
|
|||||||
|
|
||||||
A reverse proxy such as [Caddy](https://caddyserver.com), [NGINX](https://www.nginx.com) or
|
A reverse proxy such as [Caddy](https://caddyserver.com), [NGINX](https://www.nginx.com) or
|
||||||
[HAProxy](http://www.haproxy.org) is useful for deployments. Configuring this is not covered in this documentation, although sample configurations
|
[HAProxy](http://www.haproxy.org) is useful for deployments. Configuring this is not covered in this documentation, although sample configurations
|
||||||
for [Caddy](https://github.com/matrix-org/dendrite/blob/main/docs/caddy) and
|
for [Caddy](https://github.com/element-hq/dendrite/blob/main/docs/caddy) and
|
||||||
[NGINX](https://github.com/matrix-org/dendrite/blob/main/docs/nginx) are provided.
|
[NGINX](https://github.com/element-hq/dendrite/blob/main/docs/nginx) are provided.
|
||||||
|
|
||||||
### Windows
|
### Windows
|
||||||
|
|
||||||
|
@ -9,7 +9,7 @@ permalink: /installation/docker/install
|
|||||||
|
|
||||||
# Installing Dendrite using Docker Compose
|
# Installing Dendrite using Docker Compose
|
||||||
|
|
||||||
Dendrite provides an [example](https://github.com/matrix-org/dendrite/blob/main/build/docker/docker-compose.yml)
|
Dendrite provides an [example](https://github.com/element-hq/dendrite/blob/main/build/docker/docker-compose.yml)
|
||||||
Docker compose file, which needs some preparation to start successfully.
|
Docker compose file, which needs some preparation to start successfully.
|
||||||
Please note that this compose file only has Postgres as a dependency, and you need to configure
|
Please note that this compose file only has Postgres as a dependency, and you need to configure
|
||||||
a [reverse proxy](../planning#reverse-proxy).
|
a [reverse proxy](../planning#reverse-proxy).
|
||||||
@ -57,5 +57,5 @@ You can then change `config/dendrite.yaml` to your liking.
|
|||||||
Once you're done changing the config, you can now start up Dendrite with
|
Once you're done changing the config, you can now start up Dendrite with
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker-compose -f docker-compose.yml up
|
docker-compose -f docker-compose.yml up
|
||||||
```
|
```
|
||||||
|
@ -16,8 +16,8 @@ helm repo add dendrite https://matrix-org.github.io/dendrite/
|
|||||||
helm repo update
|
helm repo update
|
||||||
```
|
```
|
||||||
|
|
||||||
Next you'll need to create a `values.yaml` file and configure it to your liking. All possible values can be found
|
Next you'll need to create a `values.yaml` file and configure it to your liking. All possible values can be found
|
||||||
[here](https://github.com/matrix-org/dendrite/blob/main/helm/dendrite/values.yaml), but at least you need to configure
|
[here](https://github.com/element-hq/dendrite/blob/main/helm/dendrite/values.yaml), but at least you need to configure
|
||||||
a `server_name`, otherwise the chart will complain about it:
|
a `server_name`, otherwise the chart will complain about it:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
@ -55,4 +55,4 @@ dendrite_config:
|
|||||||
server_name: "localhost"
|
server_name: "localhost"
|
||||||
```
|
```
|
||||||
|
|
||||||
Using this option, the `database.connection_string` will be set for you automatically.
|
Using this option, the `database.connection_string` will be set for you automatically.
|
||||||
|
@ -11,7 +11,7 @@ permalink: /installation/manual/configuration
|
|||||||
A YAML configuration file is used to configure Dendrite. A sample configuration file is
|
A YAML configuration file is used to configure Dendrite. A sample configuration file is
|
||||||
present in the top level of the Dendrite repository:
|
present in the top level of the Dendrite repository:
|
||||||
|
|
||||||
* [`dendrite-sample.yaml`](https://github.com/matrix-org/dendrite/blob/main/dendrite-sample.yaml)
|
* [`dendrite-sample.yaml`](https://github.com/element-hq/dendrite/blob/main/dendrite-sample.yaml)
|
||||||
|
|
||||||
You will need to duplicate the sample, calling it `dendrite.yaml` for example, and then
|
You will need to duplicate the sample, calling it `dendrite.yaml` for example, and then
|
||||||
tailor it to your installation. At a minimum, you will need to populate the following
|
tailor it to your installation. At a minimum, you will need to populate the following
|
||||||
@ -81,7 +81,7 @@ one address in the `addresses` field.
|
|||||||
|
|
||||||
## Database connection using a global connection pool
|
## Database connection using a global connection pool
|
||||||
|
|
||||||
If you want to use a single connection pool to a single PostgreSQL database,
|
If you want to use a single connection pool to a single PostgreSQL database,
|
||||||
then you must uncomment and configure the `database` section within the `global` section:
|
then you must uncomment and configure the `database` section within the `global` section:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
@ -103,9 +103,9 @@ these will override the `global` database configuration.
|
|||||||
|
|
||||||
Dendrite supports full-text indexing using [Bleve](https://github.com/blevesearch/bleve). It is configured in the `sync_api` section as follows.
|
Dendrite supports full-text indexing using [Bleve](https://github.com/blevesearch/bleve). It is configured in the `sync_api` section as follows.
|
||||||
|
|
||||||
Depending on the language most likely to be used on the server, it might make sense to change the `language` used when indexing,
|
Depending on the language most likely to be used on the server, it might make sense to change the `language` used when indexing,
|
||||||
to ensure the returned results match the expectations. A full list of possible languages
|
to ensure the returned results match the expectations. A full list of possible languages
|
||||||
can be found [here](https://github.com/matrix-org/dendrite/blob/5b73592f5a4dddf64184fcbe33f4c1835c656480/internal/fulltext/bleve.go#L25-L46).
|
can be found [here](https://github.com/element-hq/dendrite/blob/5b73592f5a4dddf64184fcbe33f4c1835c656480/internal/fulltext/bleve.go#L25-L46).
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
sync_api:
|
sync_api:
|
||||||
|
@ -10,9 +10,9 @@ keywords:
|
|||||||
- chat
|
- chat
|
||||||
- homeserver
|
- homeserver
|
||||||
- dendrite
|
- dendrite
|
||||||
home: https://github.com/matrix-org/dendrite
|
home: https://github.com/element-hq/dendrite
|
||||||
sources:
|
sources:
|
||||||
- https://github.com/matrix-org/dendrite
|
- https://github.com/element-hq/dendrite
|
||||||
dependencies:
|
dependencies:
|
||||||
- name: postgresql
|
- name: postgresql
|
||||||
version: 14.2.3
|
version: 14.2.3
|
||||||
|
@ -32,7 +32,7 @@ Create a folder `appservices` and place your configurations in there. The confi
|
|||||||
|
|
||||||
## Source Code
|
## Source Code
|
||||||
|
|
||||||
* <https://github.com/matrix-org/dendrite>
|
* <https://github.com/element-hq/dendrite>
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
| Repository | Name | Version |
|
| Repository | Name | Version |
|
||||||
@ -42,7 +42,7 @@ Create a folder `appservices` and place your configurations in there. The confi
|
|||||||
|
|
||||||
| Key | Type | Default | Description |
|
| Key | Type | Default | Description |
|
||||||
|-----|------|---------|-------------|
|
|-----|------|---------|-------------|
|
||||||
| image.repository | string | `"ghcr.io/matrix-org/dendrite-monolith"` | Docker repository/image to use |
|
| image.repository | string | `"ghcr.io/element-hq/dendrite-monolith"` | Docker repository/image to use |
|
||||||
| image.pullPolicy | string | `"IfNotPresent"` | Kubernetes pullPolicy |
|
| image.pullPolicy | string | `"IfNotPresent"` | Kubernetes pullPolicy |
|
||||||
| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. |
|
| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. |
|
||||||
| imagePullSecrets | list | `[]` | Configure image pull secrets to use private container registry https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#create-a-pod-that-uses-your-secret |
|
| imagePullSecrets | list | `[]` | Configure image pull secrets to use private container registry https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#create-a-pod-that-uses-your-secret |
|
||||||
@ -135,7 +135,7 @@ Create a folder `appservices` and place your configurations in there. The confi
|
|||||||
| dendrite_config.sync_api.search | object | `{"enabled":true,"index_path":"/data/search","language":"en"}` | Configuration for the full-text search engine. |
|
| dendrite_config.sync_api.search | object | `{"enabled":true,"index_path":"/data/search","language":"en"}` | Configuration for the full-text search engine. |
|
||||||
| dendrite_config.sync_api.search.enabled | bool | `true` | Whether fulltext search is enabled. |
|
| dendrite_config.sync_api.search.enabled | bool | `true` | Whether fulltext search is enabled. |
|
||||||
| dendrite_config.sync_api.search.index_path | string | `"/data/search"` | The path to store the search index in. |
|
| dendrite_config.sync_api.search.index_path | string | `"/data/search"` | The path to store the search index in. |
|
||||||
| dendrite_config.sync_api.search.language | string | `"en"` | The language most likely to be used on the server - used when indexing, to ensure the returned results match expectations. A full list of possible languages can be found [here](https://github.com/matrix-org/dendrite/blob/76db8e90defdfb9e61f6caea8a312c5d60bcc005/internal/fulltext/bleve.go#L25-L46) |
|
| dendrite_config.sync_api.search.language | string | `"en"` | The language most likely to be used on the server - used when indexing, to ensure the returned results match expectations. A full list of possible languages can be found [here](https://github.com/element-hq/dendrite/blob/76db8e90defdfb9e61f6caea8a312c5d60bcc005/internal/fulltext/bleve.go#L25-L46) |
|
||||||
| dendrite_config.user_api.bcrypt_cost | int | `10` | bcrypt cost to use when hashing passwords. (ranges from 4-31; 4 being least secure, 31 being most secure; _NOTE: Using a too high value can cause clients to timeout and uses more CPU._) |
|
| dendrite_config.user_api.bcrypt_cost | int | `10` | bcrypt cost to use when hashing passwords. (ranges from 4-31; 4 being least secure, 31 being most secure; _NOTE: Using a too high value can cause clients to timeout and uses more CPU._) |
|
||||||
| dendrite_config.user_api.openid_token_lifetime_ms | int | `3600000` | OpenID Token lifetime in milliseconds. |
|
| dendrite_config.user_api.openid_token_lifetime_ms | int | `3600000` | OpenID Token lifetime in milliseconds. |
|
||||||
| dendrite_config.user_api.push_gateway_disable_tls_validation | bool | `false` | |
|
| dendrite_config.user_api.push_gateway_disable_tls_validation | bool | `false` | |
|
||||||
@ -191,4 +191,4 @@ grafana:
|
|||||||
PS: The label `release=kube-prometheus-stack` is setup with the helmchart of the Prometheus Operator. For Grafana Dashboards it may be necessary to enable scanning in the correct namespaces (or ALL), enabled by `sidecar.dashboards.searchNamespace` in [Helmchart of grafana](https://artifacthub.io/packages/helm/grafana/grafana) (which is part of PrometheusOperator, so `grafana.sidecar.dashboards.searchNamespace`)
|
PS: The label `release=kube-prometheus-stack` is setup with the helmchart of the Prometheus Operator. For Grafana Dashboards it may be necessary to enable scanning in the correct namespaces (or ALL), enabled by `sidecar.dashboards.searchNamespace` in [Helmchart of grafana](https://artifacthub.io/packages/helm/grafana/grafana) (which is part of PrometheusOperator, so `grafana.sidecar.dashboards.searchNamespace`)
|
||||||
|
|
||||||
----------------------------------------------
|
----------------------------------------------
|
||||||
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
|
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
|
||||||
|
@ -21,7 +21,7 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"description": "Dendrite dashboard from https://github.com/matrix-org/dendrite/",
|
"description": "Dendrite dashboard from https://github.com/element-hq/dendrite/",
|
||||||
"editable": true,
|
"editable": true,
|
||||||
"fiscalYearStartMonth": 0,
|
"fiscalYearStartMonth": 0,
|
||||||
"gnetId": 13916,
|
"gnetId": 13916,
|
||||||
@ -95,9 +95,7 @@
|
|||||||
"justifyMode": "auto",
|
"justifyMode": "auto",
|
||||||
"orientation": "auto",
|
"orientation": "auto",
|
||||||
"reduceOptions": {
|
"reduceOptions": {
|
||||||
"calcs": [
|
"calcs": ["lastNotNull"],
|
||||||
"lastNotNull"
|
|
||||||
],
|
|
||||||
"fields": "",
|
"fields": "",
|
||||||
"values": false
|
"values": false
|
||||||
},
|
},
|
||||||
@ -191,10 +189,7 @@
|
|||||||
"id": 6,
|
"id": 6,
|
||||||
"options": {
|
"options": {
|
||||||
"legend": {
|
"legend": {
|
||||||
"calcs": [
|
"calcs": ["mean", "lastNotNull"],
|
||||||
"mean",
|
|
||||||
"lastNotNull"
|
|
||||||
],
|
|
||||||
"displayMode": "table",
|
"displayMode": "table",
|
||||||
"placement": "right",
|
"placement": "right",
|
||||||
"showLegend": true
|
"showLegend": true
|
||||||
@ -326,10 +321,7 @@
|
|||||||
"id": 10,
|
"id": 10,
|
||||||
"options": {
|
"options": {
|
||||||
"legend": {
|
"legend": {
|
||||||
"calcs": [
|
"calcs": ["mean", "lastNotNull"],
|
||||||
"mean",
|
|
||||||
"lastNotNull"
|
|
||||||
],
|
|
||||||
"displayMode": "table",
|
"displayMode": "table",
|
||||||
"placement": "right",
|
"placement": "right",
|
||||||
"showLegend": true
|
"showLegend": true
|
||||||
@ -384,10 +376,7 @@
|
|||||||
"refresh": "10s",
|
"refresh": "10s",
|
||||||
"schemaVersion": 37,
|
"schemaVersion": 37,
|
||||||
"style": "dark",
|
"style": "dark",
|
||||||
"tags": [
|
"tags": ["matrix", "dendrite"],
|
||||||
"matrix",
|
|
||||||
"dendrite"
|
|
||||||
],
|
|
||||||
"templating": {
|
"templating": {
|
||||||
"list": [
|
"list": [
|
||||||
{
|
{
|
||||||
@ -411,12 +400,8 @@
|
|||||||
{
|
{
|
||||||
"current": {
|
"current": {
|
||||||
"selected": true,
|
"selected": true,
|
||||||
"text": [
|
"text": ["All"],
|
||||||
"All"
|
"value": ["$__all"]
|
||||||
],
|
|
||||||
"value": [
|
|
||||||
"$__all"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
"datasource": {
|
"datasource": {
|
||||||
"type": "prometheus",
|
"type": "prometheus",
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
{{- define "validate.config" }}
|
{{- define "validate.config" }}
|
||||||
{{- if and (not .Values.signing_key.create) (eq .Values.signing_key.existingSecret "") -}}
|
{{- if and (not .Values.signing_key.create) (eq .Values.signing_key.existingSecret "") -}}
|
||||||
{{- fail "You must create a signing key for configuration.signing_key OR specify an existing secret name in .Values.signing_key.existingSecret to mount it. (see https://github.com/matrix-org/dendrite/blob/master/docs/INSTALL.md#server-key-generation)" -}}
|
{{- fail "You must create a signing key for configuration.signing_key OR specify an existing secret name in .Values.signing_key.existingSecret to mount it. (see https://github.com/element-hq/dendrite/blob/master/docs/INSTALL.md#server-key-generation)" -}}
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
{{- if and (not .Values.postgresql.enabled) (eq .Values.dendrite_config.global.database.connection_string "") -}}
|
{{- if and (not .Values.postgresql.enabled) (eq .Values.dendrite_config.global.database.connection_string "") -}}
|
||||||
{{- fail "Database connection string must be set." -}}
|
{{- fail "Database connection string must be set." -}}
|
||||||
@ -65,4 +65,4 @@ Selector labels
|
|||||||
{{- define "dendrite.selectorLabels" -}}
|
{{- define "dendrite.selectorLabels" -}}
|
||||||
app.kubernetes.io/name: {{ include "dendrite.name" . }}
|
app.kubernetes.io/name: {{ include "dendrite.name" . }}
|
||||||
app.kubernetes.io/instance: {{ .Release.Name }}
|
app.kubernetes.io/instance: {{ .Release.Name }}
|
||||||
{{- end }}
|
{{- end }}
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
image:
|
image:
|
||||||
# -- Docker repository/image to use
|
# -- Docker repository/image to use
|
||||||
repository: "ghcr.io/matrix-org/dendrite-monolith"
|
repository: "ghcr.io/element-hq/dendrite-monolith"
|
||||||
# -- Kubernetes pullPolicy
|
# -- Kubernetes pullPolicy
|
||||||
pullPolicy: IfNotPresent
|
pullPolicy: IfNotPresent
|
||||||
# -- Overrides the image tag whose default is the chart appVersion.
|
# -- Overrides the image tag whose default is the chart appVersion.
|
||||||
@ -250,7 +250,8 @@ dendrite_config:
|
|||||||
|
|
||||||
# -- Configuration for experimental MSC's. (Valid values are: msc2836)
|
# -- Configuration for experimental MSC's. (Valid values are: msc2836)
|
||||||
mscs:
|
mscs:
|
||||||
mscs: []
|
mscs:
|
||||||
|
[]
|
||||||
# A list of enabled MSC's
|
# A list of enabled MSC's
|
||||||
# Currently valid values are:
|
# Currently valid values are:
|
||||||
# - msc2836 (Threading, see https://github.com/matrix-org/matrix-doc/pull/2836)
|
# - msc2836 (Threading, see https://github.com/matrix-org/matrix-doc/pull/2836)
|
||||||
@ -366,7 +367,7 @@ dendrite_config:
|
|||||||
index_path: "/data/search"
|
index_path: "/data/search"
|
||||||
# -- The language most likely to be used on the server - used when indexing, to
|
# -- The language most likely to be used on the server - used when indexing, to
|
||||||
# ensure the returned results match expectations. A full list of possible languages
|
# ensure the returned results match expectations. A full list of possible languages
|
||||||
# can be found [here](https://github.com/matrix-org/dendrite/blob/76db8e90defdfb9e61f6caea8a312c5d60bcc005/internal/fulltext/bleve.go#L25-L46)
|
# can be found [here](https://github.com/element-hq/dendrite/blob/76db8e90defdfb9e61f6caea8a312c5d60bcc005/internal/fulltext/bleve.go#L25-L46)
|
||||||
language: "en"
|
language: "en"
|
||||||
|
|
||||||
user_api:
|
user_api:
|
||||||
@ -382,8 +383,8 @@ dendrite_config:
|
|||||||
|
|
||||||
# -- Default logging configuration
|
# -- Default logging configuration
|
||||||
logging:
|
logging:
|
||||||
- type: std
|
- type: std
|
||||||
level: info
|
level: info
|
||||||
|
|
||||||
postgresql:
|
postgresql:
|
||||||
# -- Enable and configure postgres as the database for dendrite.
|
# -- Enable and configure postgres as the database for dendrite.
|
||||||
|
Loading…
Reference in New Issue
Block a user