Skip to content
This repository was archived by the owner on Jul 21, 2025. It is now read-only.

Commit f240aac

Browse files
committed
Merge branch 'af/archive' of github.com:element-hq/sygnal into HEAD
2 parents da48ba7 + aeb5d9b commit f240aac

File tree

6 files changed

+46
-9
lines changed

6 files changed

+46
-9
lines changed

.github/workflows/pipeline.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ jobs:
4242
python-version: "3.12"
4343
- run: python -m pip install -e .
4444
- run: python -m twisted.trial tests
45+
env:
46+
RUN_DESPITE_UNSUPPORTED: "Y"
4547

4648
run-unit-tests-olddeps:
4749
name: Unit tests (old dependencies)
@@ -60,3 +62,5 @@ jobs:
6062
- name: Install Sygnal
6163
run: python -m pip install -e .
6264
- run: python -m twisted.trial tests
65+
env:
66+
RUN_DESPITE_UNSUPPORTED: "Y"

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1+
Sygnal is now actively maintained at [element-hq/sygnal](https://github.com/element-hq/sygnal)
2+
=================================================================================================
3+
4+
Sygnal is a reference Push Gateway for [Matrix](https://matrix.org/)
5+
developed from 2019 through 2025 as part of the Matrix.org Foundation.
6+
The Matrix.org Foundation is not able to resource maintenance of Sygnal
7+
and it continues to be developed by Element.
8+
9+
See [The future of Synapse and Dendrite blog post](https://matrix.org/blog/2023/11/06/future-of-synapse-dendrite/) for more information.
10+
11+
112
Introduction
213
============
314

4-
Sygnal is a reference Push Gateway for [Matrix](https://matrix.org/).
5-
615
See https://spec.matrix.org/latest/push-gateway-api/#overview for a high
716
level overview of how notifications work in Matrix.
817

@@ -11,12 +20,6 @@ describes the protocol that Matrix Home Servers use to send notifications to Pus
1120
Gateways such as Sygnal.
1221

1322

14-
Contributing
15-
============
16-
17-
Looking to contribute to Sygnal? See [CONTRIBUTING.md](CONTRIBUTING.md)
18-
19-
2023
Setup
2124
=====
2225

docs/applications.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# This documentation is out of date!
2+
3+
This documentation page is for the versions of Sygnal maintained by the _Matrix.org Foundation_ ([github.com/matrix-org/dendrite](https://github.com/matrix-org/dendrite)), available under the Apache 2.0 licence.
4+
5+
If you are interested in the documentation for a later version of Dendrite, please refer to [https://element-hq.github.io/dendrite/](https://element-hq.github.io/dendrite/).
6+
17
# Notes for application developers
28

39
This document aims to illustrate some of the quirks, peculiarities and other

docs/troubleshooting.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# This documentation is out of date!
2+
3+
This documentation page is for the versions of Sygnal maintained by the _Matrix.org Foundation_ ([github.com/matrix-org/dendrite](https://github.com/matrix-org/dendrite)), available under the Apache 2.0 licence.
4+
5+
If you are interested in the documentation for a later version of Dendrite, please refer to [https://element-hq.github.io/dendrite/](https://element-hq.github.io/dendrite/).
6+
17
# Troubleshooting Sygnal deployments
28

39
Push notifications can be rather hard to get right, and there are plenty of

sygnal/__init__.py

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,32 @@
11
# -*- coding: utf-8 -*-
22
# Copyright 2025 New Vector Ltd.
3-
# Copyright 2020 The Matrix.org Foundation C.I.C.
3+
# Copyright 2025 The Matrix.org Foundation C.I.C.
44
#
55
# SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
66
# Please see LICENSE files in the repository root for full details.
77
#
88
# Originally licensed under the Apache License, Version 2.0:
99
# <http://www.apache.org/licenses/LICENSE-2.0>.
1010

11+
import sys
1112
from importlib.metadata import PackageNotFoundError, version
13+
from os import environ
1214

1315
try:
1416
__version__ = version("matrix-sygnal")
1517
except PackageNotFoundError:
1618
# package is not installed
1719
pass
20+
21+
if environ.get("RUN_DESPITE_UNSUPPORTED") != "Y":
22+
# Update your remotes folks.
23+
announcement = """
24+
Sygnal is no longer being developed under the matrix-org organization. See the
25+
README.md for more details.
26+
27+
Please update your git remote to pull from element-hq/sygnal:
28+
29+
git remote set-url origin git@github.com:element-hq/sygnal.git
30+
"""
31+
print(announcement)
32+
sys.exit(1)

tox.ini

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ extras =
1717

1818
allowlist_externals = poetry
1919

20+
set_env =
21+
RUN_DESPITE_UNSUPPORTED = Y
22+
2023
commands =
2124
poetry run coverage run --source=sygnal -m twisted.trial tests
2225
poetry run coverage report --sort=cover

0 commit comments

Comments
 (0)