mirror of
https://github.com/matrix-org/dendrite
synced 2024-12-04 19:42:35 +01:00
Update docs
This commit is contained in:
Till Faelligen
parent
4cc68ef922
commit
95d93b32e3
32 changed files with 69 additions and 3 deletions
|
|
@ -4,6 +4,8 @@ nav_order: 1
|
|||
permalink: /faq
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# FAQ
|
||||
|
||||
## Why does Dendrite exist?
|
||||
|
|
|
|||
|
|
@ -1,3 +1,6 @@
|
|||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Installation
|
||||
|
||||
Please note that new installation instructions can be found
|
||||
|
|
|
|||
6
docs/_includes/deprecation.html
Normal file
6
docs/_includes/deprecation.html
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
{: .warning-title }
|
||||
> This documentation is out of date!
|
||||
>
|
||||
> This documentation site is for the versions of Dendrite maintained by the <em>Matrix.org Foundation</em> (<a href="https://github.com/matrix-org/dendrite">github.com/matrix-org/dendrite</a>), available under the Apache 2.0 licence.
|
||||
>
|
||||
> If you are interested in the documentation for a later version of Dendrite, please refer to <a href="https://element-hq.github.io/dendrite/">https://element-hq.github.io/dendrite/</a>.
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
footer.site-footer {
|
||||
opacity: 10%;
|
||||
}
|
||||
|
|
@ -5,6 +5,8 @@ nav_order: 4
|
|||
permalink: /administration
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Administration
|
||||
|
||||
This section contains documentation on managing your existing Dendrite deployment.
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ permalink: /administration/createusers
|
|||
nav_order: 1
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Creating user accounts
|
||||
|
||||
User accounts can be created on a Dendrite instance in a number of ways.
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ permalink: /administration/registration
|
|||
nav_order: 2
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Enabling registration
|
||||
|
||||
Enabling registration allows users to register their own user accounts on your
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ permalink: /administration/presence
|
|||
nav_order: 3
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Enabling presence
|
||||
|
||||
Dendrite supports presence, which allows you to send your online/offline status
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ nav_order: 4
|
|||
permalink: /administration/adminapi
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Supported admin APIs
|
||||
|
||||
Dendrite supports, at present, a very small number of endpoints that allow
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ nav_order: 5
|
|||
permalink: /administration/optimisation
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Optimise your installation
|
||||
|
||||
Now that you have Dendrite running, the following tweaks will improve the reliability
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ nav_order: 6
|
|||
permalink: /administration/troubleshooting
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Troubleshooting
|
||||
|
||||
If your Dendrite installation is acting strangely, there are a few things you should
|
||||
|
|
|
|||
|
|
@ -4,6 +4,10 @@ has_children: true
|
|||
permalink: /development
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Development
|
||||
|
||||
This section contains documentation that may be useful when helping to develop
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ nav_order: 1
|
|||
permalink: /development/contributing
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Contributing to Dendrite
|
||||
|
||||
Everyone is welcome to contribute to Dendrite! We aim to make it as easy as
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ nav_order: 4
|
|||
permalink: /development/profiling
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Profiling Dendrite
|
||||
|
||||
If you are running into problems with Dendrite using excessive resources (e.g. CPU or RAM) then you can use the profiler to work out what is happening.
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ nav_order: 3
|
|||
permalink: /development/coverage
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
## Running unit tests with coverage enabled
|
||||
|
||||
Running unit tests with coverage enabled can be done with the following commands, this will generate a `integrationcover.log`
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ nav_order: 2
|
|||
permalink: /development/sytest
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# SyTest
|
||||
|
||||
Dendrite uses [SyTest](https://github.com/matrix-org/sytest) for its
|
||||
|
|
|
|||
|
|
@ -3,6 +3,8 @@ layout: home
|
|||
nav_exclude: true
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Dendrite
|
||||
|
||||
Dendrite is a second-generation Matrix homeserver written in Go! Following the microservice
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ nav_order: 2
|
|||
permalink: /installation
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Installation
|
||||
|
||||
This section contains documentation on installing a new Dendrite deployment.
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ nav_order: 1
|
|||
permalink: /installation/planning
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Planning your installation
|
||||
|
||||
## Database
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ nav_order: 2
|
|||
permalink: /installation/domainname
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Setting up the domain
|
||||
|
||||
Every Matrix server deployment requires a server name which uniquely identifies it. For
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ nav_order: 4
|
|||
permalink: /docker
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Installation using Docker
|
||||
|
||||
This section contains documentation how to install Dendrite using Docker
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@ nav_order: 1
|
|||
permalink: /installation/docker/install
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Installing Dendrite using Docker Compose
|
||||
|
||||
Dendrite provides an [example](https://github.com/matrix-org/dendrite/blob/main/build/docker/docker-compose.yml)
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ nav_order: 3
|
|||
permalink: /helm
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Helm
|
||||
|
||||
This section contains documentation how to use [Helm](https://helm.sh/) to install Dendrite on a [Kubernetes](https://kubernetes.io/) cluster.
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@ nav_order: 1
|
|||
permalink: /installation/helm/install
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Installing Dendrite using Helm
|
||||
|
||||
To install Dendrite using the Helm chart, you first have to add the repository using the following commands:
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ nav_order: 5
|
|||
permalink: /manual
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Manual Installation
|
||||
|
||||
This section contains documentation how to manually install Dendrite
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@ nav_order: 1
|
|||
permalink: /installation/manual/build
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Build all Dendrite commands
|
||||
|
||||
Dendrite has numerous utility commands in addition to the actual server binaries.
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@ grand_parent: Installation
|
|||
permalink: /installation/manual/database
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Preparing database storage
|
||||
|
||||
Dendrite uses SQL databases to store data. Depending on the database engine being used, you
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ nav_order: 3
|
|||
permalink: /installation/manual/signingkeys
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Generating signing keys
|
||||
|
||||
All Matrix homeservers require a signing private key, which will be used to authenticate
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ nav_order: 4
|
|||
permalink: /installation/manual/configuration
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Configuring Dendrite
|
||||
|
||||
A YAML configuration file is used to configure Dendrite. A sample configuration file is
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ nav_order: 5
|
|||
permalink: /installation/manual/start
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# Starting Dendrite
|
||||
|
||||
Once you have completed all preparation and installation steps,
|
||||
|
|
|
|||
|
|
@ -3,6 +3,8 @@ title: P2P Matrix
|
|||
nav_exclude: true
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
# P2P Matrix
|
||||
|
||||
These are the instructions for setting up P2P Dendrite, current as of May 2020. There's both Go stuff and JS stuff to do to set this up.
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
nav_exclude: true
|
||||
---
|
||||
|
||||
{% include deprecation.html %}
|
||||
|
||||
## Peeking
|
||||
|
||||
Local peeking is implemented as per [MSC2753](https://github.com/matrix-org/matrix-doc/pull/2753).
|
||||
|
|
|
|||
Loading…
Reference in a new issue