Просмотр исходного кода

Merge pull request #4117 from luixxiul/fix

Add copyright header to some documents
pull/4118/head
Slavi Pantaleev 1 год назад
committed by GitHub
Родитель
Сommit
541c66011c
Не найден GPG ключ соответствующий данной подписи Идентификатор GPG ключа: B5690EEEBB952194
21 измененных файлов: 219 добавлений и 0 удалений
  1. +9
    -0
      docs/configuring-captcha.md
  2. +7
    -0
      docs/configuring-playbook-base-domain-serving.md
  3. +8
    -0
      docs/configuring-playbook-federation.md
  4. +11
    -0
      docs/configuring-playbook-nginx.md
  5. +18
    -0
      docs/configuring-playbook-own-webserver.md
  6. +11
    -0
      docs/configuring-playbook-ssl-certificates.md
  7. +10
    -0
      docs/configuring-playbook-telemetry.md
  8. +13
    -0
      docs/configuring-well-known.md
  9. +17
    -0
      docs/container-images.md
  10. +12
    -0
      docs/howto-server-delegation.md
  11. +8
    -0
      docs/howto-srv-server-delegation.md
  12. +9
    -0
      docs/importing-postgres.md
  13. +7
    -0
      docs/importing-synapse-media-store.md
  14. +8
    -0
      docs/importing-synapse-sqlite.md
  15. +9
    -0
      docs/maintenance-migrating.md
  16. +11
    -0
      docs/maintenance-synapse.md
  17. +9
    -0
      docs/obtaining-access-tokens.md
  18. +6
    -0
      docs/quick-start.md
  19. +10
    -0
      docs/registering-users.md
  20. +14
    -0
      docs/self-building.md
  21. +12
    -0
      docs/updating-users-passwords.md

+ 9
- 0
docs/configuring-captcha.md Просмотреть файл

@@ -1,3 +1,12 @@
<!--
SPDX-FileCopyrightText: 2020 Justin Croonenberghs
SPDX-FileCopyrightText: 2020 - 2024 Slavi Pantaleev
SPDX-FileCopyrightText: 2022 MDAD project contributors
SPDX-FileCopyrightText: 2024 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

(Adapted from the [upstream project](https://github.com/element-hq/synapse/blob/develop/docs/CAPTCHA_SETUP.md))

# Overview


+ 7
- 0
docs/configuring-playbook-base-domain-serving.md Просмотреть файл

@@ -1,3 +1,10 @@
<!--
SPDX-FileCopyrightText: 2019 - 2024 Slavi Pantaleev
SPDX-FileCopyrightText: 2024 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Serving the base domain (optional)

By default, this playbook sets up services on your Matrix server (`matrix.example.com`), but has it configured so that it presents itself as the base domain (`example.com`). To have this server officially be responsible for Matrix services for the base domain (`example.com`), you need to set up server delegation / redirection.


+ 8
- 0
docs/configuring-playbook-federation.md Просмотреть файл

@@ -1,3 +1,11 @@
<!--
SPDX-FileCopyrightText: 2018 - 2024 Slavi Pantaleev
SPDX-FileCopyrightText: 2022 - 2024 MDAD project contributors
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Controlling Matrix federation (optional)

By default, your server federates with the whole Matrix network. That is, people on your server can communicate with people on any other Matrix server.


+ 11
- 0
docs/configuring-playbook-nginx.md Просмотреть файл

@@ -1,3 +1,14 @@
<!--
SPDX-FileCopyrightText: 2019 - 2020 MDAD project contributors
SPDX-FileCopyrightText: 2019 - 2024 Slavi Pantaleev
SPDX-FileCopyrightText: 2019 Paul Tötterman
SPDX-FileCopyrightText: 2020 - 2021 Agustin Ferrario
SPDX-FileCopyrightText: 2021 Aaron Raimist
SPDX-FileCopyrightText: 2021 Stuart Thomson

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Configure Nginx (optional, advanced)

Since 2024-01, this playbook no longer uses nginx as its reverse-proxy.

+ 18
- 0
docs/configuring-playbook-own-webserver.md Просмотреть файл

@@ -1,3 +1,21 @@
<!--
SPDX-FileCopyrightText: 2018 - 2025 Slavi Pantaleev
SPDX-FileCopyrightText: 2019 - 2024 MDAD project contributors
SPDX-FileCopyrightText: 2020 - 2021 Agustin Ferrario
SPDX-FileCopyrightText: 2020 Eneko Nieto
SPDX-FileCopyrightText: 2020 Julian Foad
SPDX-FileCopyrightText: 2020 Tomas Strand
SPDX-FileCopyrightText: 2021 Aaron Raimist
SPDX-FileCopyrightText: 2021 Colin Shea
SPDX-FileCopyrightText: 2022 François Darveau
SPDX-FileCopyrightText: 2022 Jaden Down
SPDX-FileCopyrightText: 2023 - 2024 Jost Alemann
SPDX-FileCopyrightText: 2023 Tilo Spannagel
SPDX-FileCopyrightText: 2024 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Using your own webserver, instead of this playbook's Traefik reverse-proxy (optional, advanced)

By default, this playbook installs its own [Traefik](https://traefik.io/) reverse-proxy server (in a Docker container) which listens on ports 80 and 443. If that's okay, you can skip this document.


+ 11
- 0
docs/configuring-playbook-ssl-certificates.md Просмотреть файл

@@ -1,3 +1,14 @@
<!--
SPDX-FileCopyrightText: 2018 - 2024 Slavi Pantaleev
SPDX-FileCopyrightText: 2020 - 2024 MDAD project contributors
SPDX-FileCopyrightText: 2020 Aaron Raimist
SPDX-FileCopyrightText: 2022 Alejo Diaz
SPDX-FileCopyrightText: 2022 Julian Foad
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Adjusting SSL certificate retrieval (optional, advanced)

By default, this playbook retrieves and auto-renews free SSL certificates from [Let's Encrypt](https://letsencrypt.org/) for the domains it needs (e.g. `matrix.example.com` and others)


+ 10
- 0
docs/configuring-playbook-telemetry.md Просмотреть файл

@@ -1,3 +1,13 @@
<!--
SPDX-FileCopyrightText: 2018 - 2024 Slavi Pantaleev
SPDX-FileCopyrightText: 2019 - 2022 MDAD project contributors
SPDX-FileCopyrightText: 2020 Aki Salminen
SPDX-FileCopyrightText: 2022 Aaron Raimist
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Enabling Telemetry for your Matrix server (optional)

By default, this playbook configures your Matrix homeserver to not send any telemetry data anywhere.


+ 13
- 0
docs/configuring-well-known.md Просмотреть файл

@@ -1,3 +1,16 @@
<!--
SPDX-FileCopyrightText: 2018 - 2023 MDAD project contributors
SPDX-FileCopyrightText: 2018 - 2024 Slavi Pantaleev
SPDX-FileCopyrightText: 2020 André Sterba
SPDX-FileCopyrightText: 2020 Sean O'Neil
SPDX-FileCopyrightText: 2021 Martha Sokolska
SPDX-FileCopyrightText: 2022 Matt Holt
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
SPDX-FileCopyrightText: 2025 Edward Andò

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Configuring Service Discovery via .well-known

This documentation page explains how to configure Service discovery via `/.well-known/` files. Service discovery is a way for the Matrix network to discover where a Matrix server is.


+ 17
- 0
docs/container-images.md Просмотреть файл

@@ -1,3 +1,20 @@
<!--
SPDX-FileCopyrightText: 2021 - 2022 Aaron Raimist
SPDX-FileCopyrightText: 2021 - 2024 MDAD project contributors
SPDX-FileCopyrightText: 2021 - 2025 Slavi Pantaleev
SPDX-FileCopyrightText: 2021 Cody Neiman
SPDX-FileCopyrightText: 2021 Dan Arnfield
SPDX-FileCopyrightText: 2021 Marcus Proest
SPDX-FileCopyrightText: 2021 Matthew Cengia
SPDX-FileCopyrightText: 2022 Cody Wyatt Neiman
SPDX-FileCopyrightText: 2022 Julian Foad
SPDX-FileCopyrightText: 2022 Julian-Samuel Gebühr
SPDX-FileCopyrightText: 2023 Shreyas Ajjarapu
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Container images used by the playbook

This page summarizes the container ([Docker](https://www.docker.com/)) images used by the playbook when setting up your server.


+ 12
- 0
docs/howto-server-delegation.md Просмотреть файл

@@ -1,3 +1,15 @@
<!--
SPDX-FileCopyrightText: 2019 - 2024 Slavi Pantaleev
SPDX-FileCopyrightText: 2019 Julian Foad
SPDX-FileCopyrightText: 2020 Ivar Troost
SPDX-FileCopyrightText: 2020 Julian Strobl
SPDX-FileCopyrightText: 2021 MDAD project contributors
SPDX-FileCopyrightText: 2023 Antoine-Ali Zarrouk
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Server Delegation

By default, this playbook sets up services on your Matrix server (`matrix.example.com`). To have this server officially be responsible for Matrix services for the base domain (`example.com`), you need to set up server delegation / redirection.


+ 8
- 0
docs/howto-srv-server-delegation.md Просмотреть файл

@@ -1,3 +1,11 @@
<!--
SPDX-FileCopyrightText: 2023 - 2024 Antoine-Ali Zarrouk
SPDX-FileCopyrightText: 2023 - 2025 Slavi Pantaleev
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Server Delegation via a DNS SRV record (advanced)

**Reminder** : unless you are affected by the [Downsides of well-known-based Server Delegation](howto-server-delegation.md#downsides-of-well-known-based-server-delegation), we suggest you **stay on the simple/default path**: [Server Delegation](howto-server-delegation.md) by [configuring well-known files](configuring-well-known.md) at the base domain.


+ 9
- 0
docs/importing-postgres.md Просмотреть файл

@@ -1,3 +1,12 @@
<!--
SPDX-FileCopyrightText: 2019 - 2023 Slavi Pantaleev
SPDX-FileCopyrightText: 2020 - 2021 MDAD project contributors
SPDX-FileCopyrightText: 2021 Kim Brose
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Importing an existing Postgres database from another installation (optional)

You can manually import your database from a previous default installation of Synapse.


+ 7
- 0
docs/importing-synapse-media-store.md Просмотреть файл

@@ -1,3 +1,10 @@
<!--
SPDX-FileCopyrightText: 2019 - 2020 Slavi Pantaleev
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Importing `media_store` data files from an existing Synapse installation (optional)

You can manually import your `media_store` files from a previous installation of Synapse.


+ 8
- 0
docs/importing-synapse-sqlite.md Просмотреть файл

@@ -1,3 +1,11 @@
<!--
SPDX-FileCopyrightText: 2018 - 2023 Slavi Pantaleev
SPDX-FileCopyrightText: 2018 Aaron Raimist
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Importing an existing SQLite database from another Synapse installation (optional)

You can manually import your database from a previous default installation of Synapse.


+ 9
- 0
docs/maintenance-migrating.md Просмотреть файл

@@ -1,3 +1,12 @@
<!--
SPDX-FileCopyrightText: 2019 - 2024 Slavi Pantaleev
SPDX-FileCopyrightText: 2019 Michael Haak
SPDX-FileCopyrightText: 2021 - 2023 MDAD project contributors
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Migrating to new server

This documentation explains how to migrate your Matrix services (server, client, bridges, etc.) and data **from an old server to a new server**.


+ 11
- 0
docs/maintenance-synapse.md Просмотреть файл

@@ -1,3 +1,14 @@
<!--
SPDX-FileCopyrightText: 2019 - 2024 Slavi Pantaleev
SPDX-FileCopyrightText: 2020 Marcel Partap
SPDX-FileCopyrightText: 2021 - 2024 MDAD project contributors
SPDX-FileCopyrightText: 2021 Aaron Raimist
SPDX-FileCopyrightText: 2022 Dennis Ciba
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Synapse maintenance

This document shows you how to perform various maintenance tasks related to the Synapse chat server.


+ 9
- 0
docs/obtaining-access-tokens.md Просмотреть файл

@@ -1,3 +1,12 @@
<!--
SPDX-FileCopyrightText: 2022 Dennis Ciba
SPDX-FileCopyrightText: 2022 Slavi Pantaleev
SPDX-FileCopyrightText: 2025 MDAD project contributors
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Obtaining an Access Token

When setting up some optional features like bots and bridges you will need to provide an access token for some user. This document provides documentation on how to obtain such an access token.


+ 6
- 0
docs/quick-start.md Просмотреть файл

@@ -1,3 +1,9 @@
<!--
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Quick start

<!--


+ 10
- 0
docs/registering-users.md Просмотреть файл

@@ -1,3 +1,13 @@
<!--
SPDX-FileCopyrightText: 2018 - 2025 MDAD project contributors
SPDX-FileCopyrightText: 2018 - 2024 Slavi Pantaleev
SPDX-FileCopyrightText: 2019 Aaron Raimist
SPDX-FileCopyrightText: 2024 Dark Decoy
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Registering users

This documentation page tells you how to create user accounts on your Matrix server.


+ 14
- 0
docs/self-building.md Просмотреть файл

@@ -1,3 +1,17 @@
<!--
SPDX-FileCopyrightText: 2020 - 2025 Slavi Pantaleev
SPDX-FileCopyrightText: 2020 Horvath Gergely
SPDX-FileCopyrightText: 2020 Marcel Partap
SPDX-FileCopyrightText: 2021 - 2022 MDAD project contributors
SPDX-FileCopyrightText: 2021 Aaron Raimist
SPDX-FileCopyrightText: 2021 Panagiotis Georgiadis
SPDX-FileCopyrightText: 2022 Arthur Brugière
SPDX-FileCopyrightText: 2023 Shreyas Ajjarapu
SPDX-FileCopyrightText: 2024 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Self-building

**Caution: self-building does not have to be used on its own. See the [Alternative Architectures](alternative-architectures.md) page.**


+ 12
- 0
docs/updating-users-passwords.md Просмотреть файл

@@ -1,3 +1,15 @@
<!--
SPDX-FileCopyrightText: 2019 - 2020 Aaron Raimist
SPDX-FileCopyrightText: 2019 Lyubomir Popov
SPDX-FileCopyrightText: 2020 - 2024 Slavi Pantaleev
SPDX-FileCopyrightText: 2020 MDAD project contributors
SPDX-FileCopyrightText: 2022 Dennis Ciba
SPDX-FileCopyrightText: 2022 Marko Weltzer
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Updating users passwords

## Option 1 (if you are using the integrated Postgres database):


Загрузка…
Отмена
Сохранить