Update docs

This commit is contained in:
Till Faelligen 2024-11-04 15:34:08 +01:00
parent 4cc68ef922
commit 95d93b32e3
No known key found for this signature in database
GPG key ID: ACCDC9606D472758
32 changed files with 69 additions and 3 deletions

View file

@ -4,6 +4,8 @@ nav_order: 1
permalink: /faq permalink: /faq
--- ---
{% include deprecation.html %}
# FAQ # FAQ
## Why does Dendrite exist? ## Why does Dendrite exist?

View file

@ -1,3 +1,6 @@
{% include deprecation.html %}
# Installation # Installation
Please note that new installation instructions can be found Please note that new installation instructions can be found

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

View file

@ -1,3 +0,0 @@
footer.site-footer {
opacity: 10%;
}

View file

@ -5,6 +5,8 @@ nav_order: 4
permalink: /administration permalink: /administration
--- ---
{% include deprecation.html %}
# Administration # Administration
This section contains documentation on managing your existing Dendrite deployment. This section contains documentation on managing your existing Dendrite deployment.

View file

@ -5,6 +5,8 @@ permalink: /administration/createusers
nav_order: 1 nav_order: 1
--- ---
{% include deprecation.html %}
# Creating user accounts # Creating user accounts
User accounts can be created on a Dendrite instance in a number of ways. User accounts can be created on a Dendrite instance in a number of ways.

View file

@ -5,6 +5,8 @@ permalink: /administration/registration
nav_order: 2 nav_order: 2
--- ---
{% include deprecation.html %}
# Enabling registration # Enabling registration
Enabling registration allows users to register their own user accounts on your Enabling registration allows users to register their own user accounts on your

View file

@ -5,6 +5,8 @@ permalink: /administration/presence
nav_order: 3 nav_order: 3
--- ---
{% include deprecation.html %}
# Enabling presence # Enabling presence
Dendrite supports presence, which allows you to send your online/offline status Dendrite supports presence, which allows you to send your online/offline status

View file

@ -5,6 +5,8 @@ nav_order: 4
permalink: /administration/adminapi permalink: /administration/adminapi
--- ---
{% include deprecation.html %}
# Supported admin APIs # Supported admin APIs
Dendrite supports, at present, a very small number of endpoints that allow Dendrite supports, at present, a very small number of endpoints that allow

View file

@ -6,6 +6,8 @@ nav_order: 5
permalink: /administration/optimisation permalink: /administration/optimisation
--- ---
{% include deprecation.html %}
# Optimise your installation # Optimise your installation
Now that you have Dendrite running, the following tweaks will improve the reliability Now that you have Dendrite running, the following tweaks will improve the reliability

View file

@ -5,6 +5,8 @@ nav_order: 6
permalink: /administration/troubleshooting permalink: /administration/troubleshooting
--- ---
{% include deprecation.html %}
# Troubleshooting # Troubleshooting
If your Dendrite installation is acting strangely, there are a few things you should If your Dendrite installation is acting strangely, there are a few things you should

View file

@ -4,6 +4,10 @@ has_children: true
permalink: /development permalink: /development
--- ---
{% include deprecation.html %}
{% include deprecation.html %}
# Development # Development
This section contains documentation that may be useful when helping to develop This section contains documentation that may be useful when helping to develop

View file

@ -5,6 +5,8 @@ nav_order: 1
permalink: /development/contributing permalink: /development/contributing
--- ---
{% include deprecation.html %}
# Contributing to Dendrite # Contributing to Dendrite
Everyone is welcome to contribute to Dendrite! We aim to make it as easy as Everyone is welcome to contribute to Dendrite! We aim to make it as easy as

View file

@ -5,6 +5,8 @@ nav_order: 4
permalink: /development/profiling permalink: /development/profiling
--- ---
{% include deprecation.html %}
# Profiling Dendrite # 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. 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.

View file

@ -5,6 +5,8 @@ nav_order: 3
permalink: /development/coverage permalink: /development/coverage
--- ---
{% include deprecation.html %}
## Running unit tests with coverage enabled ## 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` Running unit tests with coverage enabled can be done with the following commands, this will generate a `integrationcover.log`

View file

@ -5,6 +5,8 @@ nav_order: 2
permalink: /development/sytest permalink: /development/sytest
--- ---
{% include deprecation.html %}
# SyTest # SyTest
Dendrite uses [SyTest](https://github.com/matrix-org/sytest) for its Dendrite uses [SyTest](https://github.com/matrix-org/sytest) for its

View file

@ -3,6 +3,8 @@ layout: home
nav_exclude: true nav_exclude: true
--- ---
{% include deprecation.html %}
# Dendrite # Dendrite
Dendrite is a second-generation Matrix homeserver written in Go! Following the microservice Dendrite is a second-generation Matrix homeserver written in Go! Following the microservice

View file

@ -5,6 +5,8 @@ nav_order: 2
permalink: /installation permalink: /installation
--- ---
{% include deprecation.html %}
# Installation # Installation
This section contains documentation on installing a new Dendrite deployment. This section contains documentation on installing a new Dendrite deployment.

View file

@ -5,6 +5,8 @@ nav_order: 1
permalink: /installation/planning permalink: /installation/planning
--- ---
{% include deprecation.html %}
# Planning your installation # Planning your installation
## Database ## Database

View file

@ -5,6 +5,8 @@ nav_order: 2
permalink: /installation/domainname permalink: /installation/domainname
--- ---
{% include deprecation.html %}
# Setting up the domain # Setting up the domain
Every Matrix server deployment requires a server name which uniquely identifies it. For Every Matrix server deployment requires a server name which uniquely identifies it. For

View file

@ -6,6 +6,8 @@ nav_order: 4
permalink: /docker permalink: /docker
--- ---
{% include deprecation.html %}
# Installation using Docker # Installation using Docker
This section contains documentation how to install Dendrite using Docker This section contains documentation how to install Dendrite using Docker

View file

@ -7,6 +7,8 @@ nav_order: 1
permalink: /installation/docker/install permalink: /installation/docker/install
--- ---
{% include deprecation.html %}
# 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/matrix-org/dendrite/blob/main/build/docker/docker-compose.yml)

View file

@ -6,6 +6,8 @@ nav_order: 3
permalink: /helm permalink: /helm
--- ---
{% include deprecation.html %}
# Helm # Helm
This section contains documentation how to use [Helm](https://helm.sh/) to install Dendrite on a [Kubernetes](https://kubernetes.io/) cluster. This section contains documentation how to use [Helm](https://helm.sh/) to install Dendrite on a [Kubernetes](https://kubernetes.io/) cluster.

View file

@ -7,6 +7,8 @@ nav_order: 1
permalink: /installation/helm/install permalink: /installation/helm/install
--- ---
{% include deprecation.html %}
# Installing Dendrite using Helm # Installing Dendrite using Helm
To install Dendrite using the Helm chart, you first have to add the repository using the following commands: To install Dendrite using the Helm chart, you first have to add the repository using the following commands:

View file

@ -6,6 +6,8 @@ nav_order: 5
permalink: /manual permalink: /manual
--- ---
{% include deprecation.html %}
# Manual Installation # Manual Installation
This section contains documentation how to manually install Dendrite This section contains documentation how to manually install Dendrite

View file

@ -7,6 +7,8 @@ nav_order: 1
permalink: /installation/manual/build permalink: /installation/manual/build
--- ---
{% include deprecation.html %}
# Build all Dendrite commands # Build all Dendrite commands
Dendrite has numerous utility commands in addition to the actual server binaries. Dendrite has numerous utility commands in addition to the actual server binaries.

View file

@ -7,6 +7,8 @@ grand_parent: Installation
permalink: /installation/manual/database permalink: /installation/manual/database
--- ---
{% include deprecation.html %}
# Preparing database storage # Preparing database storage
Dendrite uses SQL databases to store data. Depending on the database engine being used, you Dendrite uses SQL databases to store data. Depending on the database engine being used, you

View file

@ -6,6 +6,8 @@ nav_order: 3
permalink: /installation/manual/signingkeys permalink: /installation/manual/signingkeys
--- ---
{% include deprecation.html %}
# Generating signing keys # Generating signing keys
All Matrix homeservers require a signing private key, which will be used to authenticate All Matrix homeservers require a signing private key, which will be used to authenticate

View file

@ -6,6 +6,8 @@ nav_order: 4
permalink: /installation/manual/configuration permalink: /installation/manual/configuration
--- ---
{% include deprecation.html %}
# Configuring Dendrite # Configuring Dendrite
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

View file

@ -6,6 +6,8 @@ nav_order: 5
permalink: /installation/manual/start permalink: /installation/manual/start
--- ---
{% include deprecation.html %}
# Starting Dendrite # Starting Dendrite
Once you have completed all preparation and installation steps, Once you have completed all preparation and installation steps,

View file

@ -3,6 +3,8 @@ title: P2P Matrix
nav_exclude: true nav_exclude: true
--- ---
{% include deprecation.html %}
# P2P Matrix # 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. 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.

View file

@ -2,6 +2,8 @@
nav_exclude: true nav_exclude: true
--- ---
{% include deprecation.html %}
## Peeking ## Peeking
Local peeking is implemented as per [MSC2753](https://github.com/matrix-org/matrix-doc/pull/2753). Local peeking is implemented as per [MSC2753](https://github.com/matrix-org/matrix-doc/pull/2753).