Update GSoC authored by Gaba's avatar Gaba
...@@ -55,7 +55,7 @@ with you to help choose which of your ideas to begin with. ...@@ -55,7 +55,7 @@ with you to help choose which of your ideas to begin with.
Up to this point, the Arti APIs have had limited use by external contributors so you would be an early adopter and be able to influence the APIs' evolution. Up to this point, the Arti APIs have had limited use by external contributors so you would be an early adopter and be able to influence the APIs' evolution.
## 3. Snowflake landing page revamp for GSOC 2023 ## 3. Snowflake landing page revamp
- Mentor(s): raya (looking for a co-mentor) - Mentor(s): raya (looking for a co-mentor)
- Hours required: 100 hours - Hours required: 100 hours
...@@ -82,19 +82,30 @@ The main source of information on Snowflake – addressed to the general public ...@@ -82,19 +82,30 @@ The main source of information on Snowflake – addressed to the general public
- Improve guide for running standalone Snowflake proxy: https://gitlab.torproject.org/tpo/web/community/-/issues/301 - Improve guide for running standalone Snowflake proxy: https://gitlab.torproject.org/tpo/web/community/-/issues/301
## 4. ## 4. The Tor network status API
- Mentor: - Mentor: hiro, GeKo
- Hours required: - Hours required: 175 hours
- Skills required: - Skills required: Rust, RESTful architectures
- Skills preferred: - Expected outcome: An API providing network and node status information
- Expected outcome: - Difficulty: medium
- Difficulty:
### Problem ### Problem
We are in the process of building a service to store and index documents produced by network nodes into a postgresql database and a timeseries database (VictoriaMetrics).
We want to design a RESTful API to query the two databases and provide metrics about the current status of the network and its nodes.
### Proposal ### Proposal
This project will involve the design of a web-based API to provide status information and metrics about the Tor network and its individual nodes.
Onionoo is our current web-based protocol to learn about running Tor relays and bridges, we want to design a RESTful service extending and/or redesigning the onionoo protocol, using our new data pipeline [1].
The focus should be placed on designing the API and its requests and response formats. The proposed framework is actix [2] a web framework for Rust.
*Resources*
- https://gitlab.torproject.org/tpo/network-health/team/-/wikis/metrics/collector/pipeline#proposed-architecture
- https://docs.rs/actix-web/latest/actix_web/
--- ---
--- ---
... ...
......