torproject/community
1
0
Fork 0
mirror of https://github.com/torproject/community.git synced 2024-11-23 09:49:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updates Tor Weather idea for gsoc and adds link to this year projects.

Browse Source
This commit is contained in:
Gaba 2022-03-12 04:00:44 +13:00
parent 8d462b8dc0
commit 0025d4c7b1
2 changed files with 27 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
content/gsoc/contents.lr
View File

@ -20,4 +20,6 @@ title: Project Ideas
---
body:
You may find some of these projects to be good ideas for Google Summer of Code. We have labelled each idea with which of our core developers would be good mentors. If one or more of these ideas looks promising to you, please [contact us](mailto:gso+c@torproject.org) to discuss your plans rather than sending blind applications.
You may find some of these projects to be good ideas for Google Summer of Code. We have labeled each idea with which of our core developers would be good mentors. If one or more of these ideas looks promising to you, please [contact us](mailto:gso+c@torproject.org) to discuss your plans rather than sending blind applications.
For this year's projects in Google Summer of Code you can look at the [Google Summer of Code's wiki page](https://gitlab.torproject.org/tpo/team/-/wikis/GSoC).

43
content/gsoc/tor-weather/contents.lr
View File

@ -47,30 +47,35 @@ Right now, there is very little direct feedback given to relay operators. This c
This project would involve the implementation of an email notification service that relay operators can subscribe to and choose which notifications they want to receive about their relay.
This project already existed and was known as "Tor Weather". It was unfortunately [discontinued](https://lists.torproject.org/pipermail/tor-relays/2016-April/009009.html) due to lack of maintenance and resources to keep the project alive. However, we think that this is still a great idea and the most efficient way to achieve and maintain a healthy Tor network on the long run. The resulting service should conform to our current [styleguide](https://styleguide.torproject.org/).
This project already existed and was known as "Tor Weather". It was unfortunately discontinued due to lack of maintenance and resources to keep the project alive. However, we think that this is still a great idea and the most efficient way to achieve and maintain a healthy Tor network on the long run. The resulting service should conform to our current styleguide.
There is a repository, maintained independently from the Tor project, with code that we could think about reusing and expanding upon for implementing this proposal. It's at <https://github.com/thingless/torweather/>. There are additional resources below which should get evaluated to find the right design choice for a new Tor Weather service.
This notification service should support subscribing via single relay fingerprint or MyFamily groups. Additionally, it should not need any subscription change if a new relay gets added to the family. As this service would store email addresses of potential tor relay operators, they should be kept private and safeguarded. However, a passive observer can collect them by watching outbound email traffic if no TLS is used. As such, this service should suggest using a dedicated email address for this service.
Once a basic email notification service is implemented, these are some ideas for potential notification types that could be implemented within it:
- Email me when my node is down - Here we should decide how long before we send a notification?
- Email me when my relay is affected by a security vulnerability
- Email me when my relay runs an end-of-life version of tor
- Email me when my relay runs an outdated tor version
- Email me when my exit relay fails to resolve hostnames (DNS failure)
- Email me when my relay loses the stable/guard/exit flag
- Email me when my MyFamily configuration is broken
- Email me when you detect issues with my relay
- Email me with suggestions for configuration improvements for my relay
- Email me when my relay is on the top 20/50/100 relays list
- Email me with monthly/quarterly status information, e.g what is my position in the overall relay list, how much traffic did my relay do during the last month, etc...
- Email me about new relay requirements
- Email me about tor relay operator events
```plaintext
Email me when my node is down - Here we should decide how long before we send a notification?
Email me when my relay is affected by a security vulnerability
Email me when my relay runs an end-of-life version of tor
Email me when my relay runs an outdated tor version
Email me when my exit relay fails to resolve hostnames (DNS failure)
Email me when my relay loses the stable/guard/exit flag
Email me when my MyFamily configuration is broken
Email me when you detect issues with my relay
Email me with suggestions for configuration improvements for my relay
Email me when my relay is on the top 20/50/100 relays list
Email me with monthly/quarterly status information, e.g what is my position in the overall relay list, how much traffic did my relay do during the last month, etc...
Email me about new relay requirements
Email me about tor relay operator events
```
For each notification implemented, there should be a corresponding specification written to describe the meaning of each notification type.
# Resources
### Resources:
- What Tor Weather looked like: https://web.archive.org/web/20141004055709/https://weather.torproject.org/subscribe/
- Tor Weather repo: https://gitweb.torproject.org/weather.git/
For the original ticket and discussion, please see ticket [#26124](http://bugs.torproject.org/26124)
- Current issue in our bug tracker: https://gitlab.torproject.org/tpo/network-health/team/-/issues/107
- Another Tor Weather code base: <https://github.com/meejah/tor-weather>
- Old Tor Weather experience: <https://web.archive.org/web/20141004055709/https://weather.torproject.org/subscribe/>
- Our old code base: <https://gitweb.torproject.org/weather.git/>