The Tor Project issueshttps://gitlab.torproject.org/groups/tpo/-/issues2024-03-27T21:42:12Zhttps://gitlab.torproject.org/tpo/onion-services/onion-launchpad/-/issues/24Deployment documentation for the Landing Page2024-03-27T21:42:12ZSilvio RhattoDeployment documentation for the Landing Page* [x] Include deployment documentation in the Landing Page's [README.md](https://gitlab.torproject.org/tpo/onion-services/sponsor123-landing-page/-/blob/main/README.md) and/or `docs/` folder.
* [ ] Document the simpler procedure (user fo...* [x] Include deployment documentation in the Landing Page's [README.md](https://gitlab.torproject.org/tpo/onion-services/sponsor123-landing-page/-/blob/main/README.md) and/or `docs/` folder.
* [ ] Document the simpler procedure (user forks Onion Launchpad's mirror on GitLab or GitHub, then configure and trigger a build).
* [ ] Document logo filename convention for automatic translations.
* [ ] Include a screenshot.
* [ ] Explain that it's useful both as a censorship circumvention tool
and as a landing portal for onion-only sites that needs to include
documentation for their users about how to get access.Onion Launchpad - 2024.Q2Silvio RhattoSilvio Rhatto2024-04-30https://gitlab.torproject.org/tpo/onion-services/oniongroove/-/issues/5Vendorize Onion MkDocs2024-03-27T21:47:27ZSilvio RhattoVendorize Onion MkDocsVendorize [Onion MkDocs](https://gitlab.torproject.org/rhatto/onion-mkdocs), so it's easier to retrieve updates.Vendorize [Onion MkDocs](https://gitlab.torproject.org/rhatto/onion-mkdocs), so it's easier to retrieve updates.Oniongroove 0.1.0Silvio RhattoSilvio Rhatto2024-05-16https://gitlab.torproject.org/tpo/onion-services/ecosystem/-/issues/1Hosting location for the Onion Services Ecosystem Documentation2024-03-27T22:03:23ZSilvio RhattoHosting location for the Onion Services Ecosystem Documentation# Motivation
As mentioned in the [previous issue][] about getting domains for some Onion Services projects, we're looking for
* Shorter URLs for some Onion Services related projects, pointing to their GitLab Pages.
* Aggregate Onion Se...# Motivation
As mentioned in the [previous issue][] about getting domains for some Onion Services projects, we're looking for
* Shorter URLs for some Onion Services related projects, pointing to their GitLab Pages.
* Aggregate Onion Services documentation in a single, searchable place.
That made us create the [Onion Services Ecosystem Documentation][], but it still has a not very friendly URL.
[previous issue]: tpo/onion-services/onion-support#202
[Onion Services Ecosystem Documentation]: https://tpo.pages.torproject.net/onion-services/ecosystem
# Tasks
* [x] Organization:
* [x] Ping some people to get feedback (ahf, gaba, micah?).
* [x] Determine a better canonical URL location for the [Onion Services Ecosystem Documentation][]:
* [x] Project/repository name: `tpo/onion-services/ecosystem`.
* [x] Canonical URL: `https://community.torproject.org/onion-services/ecosystem`.
* [x] Rename the project from `portal` to `ecosystem`.
* [ ] Implementation:
* [x] Proceed with the CI/deployment changes to make the [Onion Services Ecosystem Documentation][] accessible through the new URL:
* [~] Update CI config to use the [static shim][] deploying to the [static component]. No need, since we'll use the existing deployment from `tpo/web/community`.
* [x] Update CI config to use a setup [similiar to the Community Policies][] (tpo/onion-services/ecosystem!6).
* [x] Update [web/community CI config](https://gitlab.torproject.org/tpo/web/community/-/blob/main/.gitlab-ci.yml) to include the Ecosystem Docs (tpo/web/community!349).
* [~] [Ask TPA](https://gitlab.torproject.org/tpo/tpa/team/-/issues/new) to help with setting up this deployment. No need, since we'll use the existing deployment from `tpo/web/community`.
* [x] Update references in Onion Services projects, pointing to the new official/canonical documentation location (like on `README.md` files etc).
* [ ] Once the portal is deployed, updated the "Onionize any website" link in
the Community Portal, pointing to the official Onionspray documentation
URL within the Onion Services Ecosystem Portal (tpo/web/community#337).
* [ ] Link the [Onion Services Ecosystem Documentation] in the [Onion Services section of the Community Portal](https://community.torproject.org/onion-services/).
* [ ] Add banner in the community portal, at the [Onion Services page](https://community.torproject.org/onion-services/).
* [ ] Figure out [an update workflow](https://gitlab.torproject.org/tpo/onion-services/ecosystem/-/issues/1#note_3010677).
* [~] Bonus:
* [~] Consider to release the portal as part of the [Onion Services 20th Years Anniversary (2024 edition)](https://gitlab.torproject.org/tpo/onion-services/onionplan/-/issues/14#note_2933136).
* [~] Onion Services endpoint and Onion-Location set (if not already available). This will be available already when the docs are available through `community.torproject.org`.
[static shim]: https://gitlab.torproject.org/tpo/tpa/team/-/wikis/service/static-shim
[static component]: https://gitlab.torproject.org/tpo/tpa/team/-/wikis/howto/static-component
[similiar to the Community Policies]: https://gitlab.torproject.org/tpo/community/policies/-/blob/main/.gitlab-ci.yml
# Time estimation
* Complexity: small (1 day)
* Uncertainty: low (x1.1)
* [Reference](https://jacobian.org/2021/may/25/my-estimation-technique/) (adapted)
/cc @gusSilvio RhattoSilvio Rhatto2024-06-17https://gitlab.torproject.org/tpo/onion-services/onionspray/-/issues/51Improved troubleshooting tips2024-03-28T13:07:39ZSilvio RhattoImproved troubleshooting tips# Tasks
* [ ] Improve the "Troubleshooting" document with tips to debug Onionspray, NGINX and tor.
* [ ] Include debugging tips such as custom log configurations like `Log [rend]info notice file /var/log/tor/notices.log`
that can ...# Tasks
* [ ] Improve the "Troubleshooting" document with tips to debug Onionspray, NGINX and tor.
* [ ] Include debugging tips such as custom log configurations like `Log [rend]info notice file /var/log/tor/notices.log`
that can reduce the noise and pinpoint things (but usually is better to log all subsystems).
# Time estimation
* Complexity: negligible (0.1 day)
* Uncertainty: low (x1.1)
* [Reference](https://jacobian.org/2021/may/25/my-estimation-technique/) (adapted)Onionspray 1.7.0Silvio RhattoSilvio Rhatto2024-06-27https://gitlab.torproject.org/tpo/onion-services/onionspray/-/issues/37Documentation macros2024-02-29T19:10:44ZSilvio RhattoDocumentation macros# Tasks
* [ ] Setup the [MkDocs Macros plugin].
* [ ] Create macros to reuse some content (like the installation example using Debian bookworm).
[MkDocs Macros plugin]: https://mkdocs-macros-plugin.readthedocs.io/en/latest/
# Time est...# Tasks
* [ ] Setup the [MkDocs Macros plugin].
* [ ] Create macros to reuse some content (like the installation example using Debian bookworm).
[MkDocs Macros plugin]: https://mkdocs-macros-plugin.readthedocs.io/en/latest/
# Time estimation
* Complexity: negligible (0.1 day)
* Uncertainty: low (x1.1)
* [Reference](https://jacobian.org/2021/may/25/my-estimation-technique/) (adapted)Onionspray 1.7.0Silvio RhattoSilvio Rhatto2024-06-27https://gitlab.torproject.org/tpo/onion-services/onionspray/-/issues/36Documentation: terminology2024-02-29T19:10:44ZSilvio RhattoDocumentation: terminology# Tasks
* [x] Create a quick introductory terminology on the Onionspray elements: repository, installation, server, project, site etc.
* [ ] Review the documentation to make sure it's consistent with the terminology.
# Time estimation
...# Tasks
* [x] Create a quick introductory terminology on the Onionspray elements: repository, installation, server, project, site etc.
* [ ] Review the documentation to make sure it's consistent with the terminology.
# Time estimation
* Complexity: negligible (0.1 day)
* Uncertainty: low (x1.1)
* [Reference](https://jacobian.org/2021/may/25/my-estimation-technique/) (adapted)Onionspray 1.7.0Silvio RhattoSilvio Rhatto2024-06-27https://gitlab.torproject.org/tpo/onion-services/ecosystem/-/issues/2Add Onionbalance documentation2024-03-27T21:34:58ZSilvio RhattoAdd Onionbalance documentation# Tasks
* [ ] Add the Onionbalance documentation once it's [converted to Onion MkDocs][].
[converted to Onion MkDocs]: tpo/onion-services/onionbalance#28
# Time estimation
* Complexity: negligible (0.1 day)
* Uncertainty: low (x1.1)
...# Tasks
* [ ] Add the Onionbalance documentation once it's [converted to Onion MkDocs][].
[converted to Onion MkDocs]: tpo/onion-services/onionbalance#28
# Time estimation
* Complexity: negligible (0.1 day)
* Uncertainty: low (x1.1)
* [Reference](https://jacobian.org/2021/may/25/my-estimation-technique/) (adapted)Silvio RhattoSilvio Rhatto2024-07-01https://gitlab.torproject.org/tpo/web/community/-/issues/339Update links at the Vanity Addresses page2024-03-27T21:17:43ZSilvio RhattoUpdate links at the Vanity Addresses page# Description
[Vanity Addresses page](https://community.torproject.org/onion-services/advanced/vanity-addresses/) needs updated links/references.
Specifically, these references are outdated:
* [eotk/docs.d/TIPS-FOR-MINING-ONIONS.md at...# Description
[Vanity Addresses page](https://community.torproject.org/onion-services/advanced/vanity-addresses/) needs updated links/references.
Specifically, these references are outdated:
* [eotk/docs.d/TIPS-FOR-MINING-ONIONS.md at master · alecmuffett/eotk](https://github.com/alecmuffett/eotk/blob/master/docs.d/TIPS-FOR-MINING-ONIONS.md)
* [Onion Services UX Proposals · Wiki · The Tor Project / Onion Services / Onion Support · GitLab](https://gitlab.torproject.org/tpo/onion-services/onion-support/-/wikis/Documentation/Onion-Services-UX-Proposals)
And can be replaced by:
* [Mining Onion Service keys - Onionspray](https://tpo.pages.torproject.net/onion-services/onionspray/guides/mining/)
* [Usability intro - The Onion Plan](https://tpo.pages.torproject.net/onion-services/onionplan/proposals/usability/)
A reference to [Onionmine](https://gitlab.torproject.org/tpo/onion-services/onionmine/) would also be informative.
# Tasks
* [ ] Replace the oudated references with the newer ones.
* [ ] Add a reference to Onionmine.
# Time estimation
* Complexity: negligible (0.1 day)
* Uncertainty: low (x1.1)
* [Reference](https://jacobian.org/2021/may/25/my-estimation-technique/) (adapted)Silvio RhattoSilvio Rhatto2024-07-31https://gitlab.torproject.org/tpo/web/manual/-/issues/158Update instructions about using built-in bridges in Tor Browser2024-03-26T12:58:53Zebanamebanam@torproject.orgUpdate instructions about using built-in bridges in Tor Browserhttps://tb-manual.torproject.org/circumvention/
The UX has changed a bit. Let's review and update this section about using built-in bridges with Tor Browser.
> USING PLUGGABLE TRANSPORTS
>
> To use a pluggable transport, click "Configu...https://tb-manual.torproject.org/circumvention/
The UX has changed a bit. Let's review and update this section about using built-in bridges with Tor Browser.
> USING PLUGGABLE TRANSPORTS
>
> To use a pluggable transport, click "Configure Connection" when starting Tor Browser for the first time. Under the "Bridges" section, locate the option "Choose from one of Tor Browser's built-in bridges" and click on "Select a Built-In Bridge" option. From the menu, select whichever pluggable transport you'd like to use.
>
> Once you've selected the pluggable transport, scroll up and click "Connect" to save your settings.
>
> Or, if you have Tor Browser running, click on "Settings" in the hamburger menu (≡) and then on "Connection" in the sidebar. Under the "Bridges" section, locate the option "Choose from one of Tor Browser's built-in bridges" and click on "Select a Built-In Bridge" option. Choose whichever pluggable transport you'd like to use from the menu. Your settings will automatically be saved once you close the tab.
/cc @nina @emmapeelebanamebanam@torproject.orgebanamebanam@torproject.orghttps://gitlab.torproject.org/tpo/web/support/-/issues/358Add Letterboxing to the glossary2024-03-25T15:27:33ZemmapeelAdd Letterboxing to the glossaryWe need to add Letterboxing to the glossary, as it is a new term that we use on the documentation.We need to add Letterboxing to the glossary, as it is a new term that we use on the documentation.ebanamebanam@torproject.orgebanamebanam@torproject.orghttps://gitlab.torproject.org/tpo/web/manual/-/issues/157Add entry about letterboxing (about:manual#letterboxing)2024-03-12T20:36:03Zma1Add entry about letterboxing (about:manual#letterboxing)We're implementing a `Learn more` link in the new user-facing letteboxing preferences (tpo/applications/tor-browser#41916) and we need some content to be referenced by about:manual#letterboxing :)
@donuts' [comment](https://gitlab.torp...We're implementing a `Learn more` link in the new user-facing letteboxing preferences (tpo/applications/tor-browser#41916) and we need some content to be referenced by about:manual#letterboxing :)
@donuts' [comment](https://gitlab.torproject.org/tpo/applications/tor-browser/-/issues/32324#note_2876483):
> It's on support-dot, but possibly not the manual?
> https://support.torproject.org/tbb/maximized-torbrowser-window/ebanamebanam@torproject.orgebanamebanam@torproject.orghttps://gitlab.torproject.org/tpo/applications/tor-browser/-/issues/42440Letterboxing manual entry (about:manual#letterboxing)2024-03-18T16:26:27Zma1Letterboxing manual entry (about:manual#letterboxing)We're implementing a `Learn more` link in the new user-facing letteboxing preferences (#41916) and we need some content to be referenced by about:manual#letterboxing :)
@donuts' [comment](https://gitlab.torproject.org/tpo/applications/...We're implementing a `Learn more` link in the new user-facing letteboxing preferences (#41916) and we need some content to be referenced by about:manual#letterboxing :)
@donuts' [comment](https://gitlab.torproject.org/tpo/applications/tor-browser/-/issues/32324#note_2876483):
> It's on support-dot, but possibly not the manual?
> https://support.torproject.org/tbb/maximized-torbrowser-window/donutsdonutshttps://gitlab.torproject.org/tpo/onion-services/ecosystem/-/issues/6README update with maintenance instructions2024-02-29T12:45:41ZSilvio RhattoREADME update with maintenance instructions# Tasks
* [ ] Add into the [README](README.md):
* [ ] Onion Services doc conventions, including:
* Use the navigation format from the [mkdocs-awesome-pages-plugin][].
* Have `README.md` or `index.md` listed as the "Intro" page...# Tasks
* [ ] Add into the [README](README.md):
* [ ] Onion Services doc conventions, including:
* Use the navigation format from the [mkdocs-awesome-pages-plugin][].
* Have `README.md` or `index.md` listed as the "Intro" page.
* Have a link to the repository in the README/index page.
* [ ] How to contribute with new docs:
* Open an issue request or pull request for an evaluation/integration.
* [ ] How to integrate your existing docs:
* Need to be Onion Service related.
* Setup Onion MkDocs.
* Adopt the Onion Services doc conventions.
* Adhere to the Community Team docs guidelines.
* Open an issue request or pull request for an evaluation/integration.
[mkdocs-awesome-pages-plugin]: https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
# Time estimation
* Complexity: very small (0.5 day)
* Uncertainty: low (x1.1)
* [Reference](https://jacobian.org/2021/may/25/my-estimation-technique/) (adapted)https://gitlab.torproject.org/tpo/onion-services/ecosystem/-/issues/5Slides generation2024-02-27T18:58:24ZSilvio RhattoSlides generation# Description
Some projects have [Onion TeX Slim][]-generated slides that could be built as part of this repository CI/CD.
[Onion TeX Slim]: https://gitlab.torproject.org/tpo/community/onion-tex-slim
# Tasks
* [ ] Create a convention...# Description
Some projects have [Onion TeX Slim][]-generated slides that could be built as part of this repository CI/CD.
[Onion TeX Slim]: https://gitlab.torproject.org/tpo/community/onion-tex-slim
# Tasks
* [ ] Create a convention for [Onion TeX Slim][] slides among Onion Service documentation (folder location etc).
* [ ] Implement a CI/CD action to generate all slides, including then in the generated documentation.
# Time estimation
* Complexity: small (1 day)
* Uncertainty: low (x1.1)
* [Reference](https://jacobian.org/2021/may/25/my-estimation-technique/) (adapted)https://gitlab.torproject.org/tpo/web/snowflake/-/issues/9unify volunteer instructions from support entry onto snowflake website2024-02-27T14:24:07ZRoger Dingledineunify volunteer instructions from support entry onto snowflake websiteWe have this support entry: <br>
https://support.torproject.org/censorship/how-to-help-running-snowflake/
which tells people to install the Firefox or Chrome extension, or load the embed in a page. It doesn't mention the Edge extension ...We have this support entry: <br>
https://support.torproject.org/censorship/how-to-help-running-snowflake/
which tells people to install the Firefox or Chrome extension, or load the embed in a page. It doesn't mention the Edge extension or the standalone proxy.
Rather than trying to keep both sets of instructions in sync, I think we should put the instructions on the snowflake.torproject.org page, and point to them from a much slimmer support entry.
To achieve this goal, there are currently two things that the support entry says that the snowflake.torproject.org website does not:
* You need to enable WebRTC in your browser, to usefully run the extension or to usefully load the embed. (If we could reliably have the extension or the embed page report that your WebRTC is missing and you need to fix that, then we could get away with not saying it on the webpage. So, feel free to do that instead if it is easier, but I am suspecting it is not easier. :)
* "Due to censorship of VPN servers in some countries, we kindly ask you to not run a snowflake proxy while connected to a VPN" as advised by @cohosh at https://forum.torproject.org/t/running-a-snowflake-proxy-behind-a-vpn-consequences-for-tor-users/2047/4 and then recorded by gus at https://gitlab.torproject.org/tpo/web/support/-/issues/296. Feel free also to change your mind about the "not on a VPN please" advice.
Once we have these two items either make their way onto the snowflake.torproject.org proxy instructions or have you tell us you don't intend to, then we should be all ready to remove the (redundant, already not as correct) text from the support entry.
Thanks!https://gitlab.torproject.org/tpo/onion-services/onionbalance/-/issues/30Create a development/release workflow2024-02-20T18:00:43ZSilvio RhattoCreate a development/release workflowCreate a development and release workflow, including sending a message to the `tor-announce` mailing list.
Existing workflows that can be used as a base:
* [Development - Onionprobe](https://tpo.pages.torproject.net/onion-services/onio...Create a development and release workflow, including sending a message to the `tor-announce` mailing list.
Existing workflows that can be used as a base:
* [Development - Onionprobe](https://tpo.pages.torproject.net/onion-services/onionprobe/development/)
* [Development workflow - Onionspray](https://tpo.pages.torproject.net/onion-services/onionspray/guides/development/)Onionbalance 0.2.3https://gitlab.torproject.org/tpo/onion-services/onionbalance/-/issues/29Document about multiple MasterOnionAddress entries2024-02-20T17:58:20ZSilvio RhattoDocument about multiple MasterOnionAddress entriesDocument that multiple `MasterOnionAddress` lines are supported in the
`ob_config` file, so each backend service can work for multiple frontend
addresses.Document that multiple `MasterOnionAddress` lines are supported in the
`ob_config` file, so each backend service can work for multiple frontend
addresses.Onionbalance 0.2.3https://gitlab.torproject.org/tpo/onion-services/onionbalance/-/issues/28Migrate Onionbalance documentation to Onion MkDocs2024-02-22T22:19:20ZSilvio RhattoMigrate Onionbalance documentation to Onion MkDocsMigrate Onionbalance documentation from [Sphinx](https://www.sphinx-doc.org) to [Onion MkDocs][].
[Onion Mkdocs]: https://gitlab.torproject.org/tpo/web/onion-mkdocs/Migrate Onionbalance documentation from [Sphinx](https://www.sphinx-doc.org) to [Onion MkDocs][].
[Onion Mkdocs]: https://gitlab.torproject.org/tpo/web/onion-mkdocs/Onionbalance 0.2.3https://gitlab.torproject.org/tpo/onion-services/onionmine/-/issues/26Setup Onion MkDocs for Onionmine2024-02-22T22:06:52ZSilvio RhattoSetup Onion MkDocs for OnionmineConvert Onionmine documentation to [Onion MkDocs][].
[Onion Mkdocs]: https://gitlab.torproject.org/tpo/web/onion-mkdocs/Convert Onionmine documentation to [Onion MkDocs][].
[Onion Mkdocs]: https://gitlab.torproject.org/tpo/web/onion-mkdocs/Silvio RhattoSilvio Rhattohttps://gitlab.torproject.org/tpo/tpa/team/-/issues/41523document donate-review deployment process and project in general2024-02-14T21:09:13Zanarcatdocument donate-review deployment process and project in generalin tpo/tpa/team#41519, we have identified that donate-review lacks documentation. #41518 is a task for @lavamind to review that project, but this is for @kez to document it as much as they can.in tpo/tpa/team#41519, we have identified that donate-review lacks documentation. #41518 is a task for @lavamind to review that project, but this is for @kez to document it as much as they can.Jérôme Charaouilavamind@torproject.orgJérôme Charaouilavamind@torproject.org