Opened 7 years ago

Closed 7 years ago

#4905 closed task (implemented)

make an obfsproxy project page on the website

Reported by: arma Owned by: asn
Priority: Medium Milestone:
Component: Webpages/Website Version:
Severity: Keywords:
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

George told me at the Frankfurt hack fest that he wants to get obfsproxy into the hands of more users. Sounds great. One of the steps is to make a web page for it, so people know what resources there are, what needs testing, how to do the testing, etc.

I think https://www.torproject.org/projects/projects is a fine place to link to this page from.

Child Tickets

Attachments (5)

images.tar (50.0 KB) - added by asn 7 years ago.
tarball of images. spill them in images/
patch (8.4 KB) - added by asn 7 years ago.
minor improvements over the original patch
update-01262012.diff (2.2 KB) - added by marlowe 7 years ago.
Resolves issues brought in #tor-dev on 01/26/2012
obfsproxy-instructions-update.patch (14.9 KB) - added by marlowe 7 years ago.
Fixes for comment #11
patch.2 (2.5 KB) - added by asn 7 years ago.

Download all attachments as: .zip

Change History (20)

comment:1 Changed 7 years ago by atagar

Is obfsproxy ready for end users? If so, it has a site for a non-technical audience, and this is something we want to actively encourage end users to use then agreed.

If any of the above is 'no' then we should hold off on adding it to the projects page until it's ready. That is a page for end users, not getting beta testers - tor-talk@ and the blog are better places for that.

Regardless of if we add obfsproxy to the projects page, it still needs a trac component and to be added to the volunteer table...
https://www.torproject.org/getinvolved/volunteer.html.en#Projects

comment:2 in reply to:  1 Changed 7 years ago by arma

Replying to atagar:

Is obfsproxy ready for end users? If so, it has a site for a non-technical audience, and this is something we want to actively encourage end users to use then agreed.

I think it is ready, insofar as we think it works and some end-users are really eager to use it (or would be if they knew how to). There aren't easy precompiled packages for it yet, but that's one of the things we want to fix and right now the reason we're making no progress on packages is because we're making no progress on packages.

If you wanted to be extra conservative, we could make the page but not link to it from the projects page yet. But I think that would be too conservative.

Regardless of if we add obfsproxy to the projects page, it still needs a trac component and to be added to the volunteer table...
https://www.torproject.org/getinvolved/volunteer.html.en#Projects

So far we've been using the 'pluggable transport' trac component for it. I agree it should go on the volunteer projects table.

comment:3 in reply to:  1 Changed 7 years ago by arma

Replying to atagar:

and this is something we want to actively encourage end users to use

For some context here: if you're a Tor user in China (probes and blocks Tor addresses) or Iran (throttles all SSL flows) then you're going to have to get good at using obfsproxy, and the sooner the better. Eventually it should just be bundled in the bundles like Vidalia is; but we're not there yet.

comment:4 Changed 7 years ago by asn

obfsproxy needs testing, and it will never be truly ready for end users till end users test it...

In any case, I think that mentioning obfsproxy in the projects page could, indeed, get some more people involved with obfsproxy.

Unfortunately, obfsproxy doesn't have a cool-looking page like https://www.torproject.org/projects/arm.html.en or https://tails.boum.org/ . As a temporary solution, till an end-user-friendly webpage is created [0], maybe we can link to the doc/ directory of obfsproxy's gitweb [1].
This way, people who are looking for something to hack on, can learn about obfsproxy; and when the end-user-friendly webpage is done, we will switch the links to that.

Here are some plausible table entries for
https://www.torproject.org/getinvolved/volunteer.html.en:

Name: obfsproxy
Category: Censorship circumvention
Language: C
Activity: Moderate
Contributors: nickm, asn

Here is some brief text that could appear when clicking 'obfsproxy':

A proxy that shapes Tor traffic, making it harder for censors to detect and block Tor.

here is a "project ideas" text that could appear below (like torsocks is doing):

Project ideas:

obfsproxy is young, under development and needs your help. Run it,
test it, review or refactor code and documentation, find bugs, write
code, create or fix trac tickets ('Pluggable Transports' component),
write your own pluggable transport protocols!

The 'code' button should link to: https://gitweb.torproject.org/obfsproxy.git
and the 'bug tracker' button should link to:

https://trac.torproject.org/projects/tor/query?status=accepted&status=assigned&status=needs_information&status=needs_review&status=needs_revision&status=new&status=reopened&component=Pluggable+transport&order=priority&col=id&col=summary&col=status&col=type&col=priority&col=milestone&col=component

Here is another short introduction to obfsproxy that could be placed in https://www.torproject.org/projects/projects :

obfsproxy:

obfsproxy is a pluggable transports proxy written in C; it
shapes Tor traffic, making it harder for censors to detect and block
the Tor protocol.

Any improvements to the above descriptions are more than welcome.


I guess I should mention, that I have no idea on how to interact with the website and how to add the above strings to those pages. It would be great if it was automagically done by someone who knows how to do it, but if no one volunteers, I'll look into it sometime this week.

I'll also start looking into making a small webpage [0], similar to https://www.torproject.org/projects/arm.html.en. Again, if someone has plenty of free time and enjoys designing webpages, I would be glad to get some help.

[0]: A future obfsproxy webpage could have some links on how to get obfsproxy and how to install it, and some web-ish version of https://gitweb.torproject.org/obfsproxy.git/tree/HEAD:/doc/obfs2/howto (preferably with screenshots).

[1]: https://gitweb.torproject.org/obfsproxy.git/tree/HEAD:/doc

comment:5 Changed 7 years ago by atagar

(from arma) I think it is ready

Great.

(from asn) obfsproxy needs testing, and it will never be truly ready for end users till end users test it...

Not great.

Like I mentioned earlier, if you need beta testers then please use the blog and tor-talk@ - that's what I did for arm and it worked reasonably well.

In any case, I think that mentioning obfsproxy in the projects page could, indeed, get some more people involved with obfsproxy.

The volunteer projects table and irc are the places for getting more people involved with your project. The projects page is for Tor users who are curious what they can use without a mandatory CS degree.

Unfortunately, obfsproxy doesn't have a cool-looking page like https://www.torproject.org/projects/arm.html.en or https://tails.boum.org/ .

Glad you like them. In both cases the pages were made by the project's authors - you're certainly more than welcome to do the same for obfsproxy.

As a temporary solution, till an end-user-friendly webpage is created [0], maybe we can link to the doc/ directory of obfsproxy's gitweb [1]. This way, people who are looking for something to hack on, can learn about obfsproxy; and when the end-user-friendly webpage is done, we will switch the links to that.

I for one am definitely against that. If my parents were to click on that link they'd be left saying '... wtf am I supposed to do with this?'. Hell, even I'm not quite sure what to do with that as a user.

Again, the projects page should not require vast technical knowledge. That said, linking to that from obfsproxy's voluneer page entry would be great.

here is a "project ideas" text that could appear below (like torsocks is doing)

A project idea is a standalone project that new volunteers can hack on. Not just a general 'help wanted' posting. In torsocks' case their project is to add OSX compatibility.

Here are some plausible table entries for...

Great, I'll fill in the entry tomorrow unless someone beats me to it.

Cheers! -Damian

comment:6 in reply to:  1 Changed 7 years ago by arma

Replying to atagar:

Is obfsproxy ready for end users? If so, it has a site for a non-technical audience, and this is something we want to actively encourage end users to use then agreed.

If any of the above is 'no' then we should hold off on adding it to the projects page until it's ready. That is a page for end users, not getting beta testers

How about the compromise of making an obfsproxy project page, but not linking to it from the main projects page yet? When (if) it becomes suitable for inclusion in the main project page, we can do that then. In the mean time, asn has a place to point people who want to learn more about obfsproxy, and incentive to keep making the page better until said people can use it.

Obfsproxy has no website now, and has no place to put a website. A page on the Tor website seems like a fine choice.

comment:7 Changed 7 years ago by atagar

I'll fill in the entry tomorrow unless someone beats me to it.

Added to the volunteer table (r25312), it'll be there the next time the site is pushed. One minor change is that I went with "Client Add-on" instead of "Censorship circumvention" since the later is too long and didn't seem to fit as a general category we have listed.

How about the compromise of making an obfsproxy project page, but not linking to it from the main projects page yet?

Sounds good to me.

Obfsproxy has no website now, and has no place to put a website. A page on the Tor website seems like a fine choice.

Agreed.

Changed 7 years ago by asn

Attachment: images.tar added

tarball of images. spill them in images/

Changed 7 years ago by asn

Attachment: patch added

minor improvements over the original patch

comment:8 Changed 7 years ago by arma

I took the original patch and images and modified them a lot. They're here:
https://www.torproject.org/projects/obfsproxy.html.en
https://www.torproject.org/projects/obfsproxy-instructions.html.en

I haven't looked at (and didn't notice until now) asn's "minor improvements over the original patch" comment. So whatever it does, it's not included in the wml currently.

comment:9 Changed 7 years ago by arma

Pasting my suggestions from irc, for the instructions page:

> a) in the client section, we don't say that you need
to find the address of a bridge that supports obfsproxy. or that that's what
192.0.2.34 is.
> b) when we're presenting torrc files, we should specify which parts are new
and required for this. for example, you don't have to set your datadirectory
in order to use obfsproxy bridges.
> b2) for the things we want people to add, we should make them pasteable,
rather than hidden in images
> also, 9001 in the client example is the obfsproxy port, not the orport.
we should make the numbers match up between the client section and the bridge
section.

Changed 7 years ago by marlowe

Attachment: update-01262012.diff added

Resolves issues brought in #tor-dev on 01/26/2012

comment:10 Changed 7 years ago by marlowe

The above patch:

1) Removes the configuration pictures and replaces them with text
2) Ensures the ports match
3) Explains 192.0.2.34 and its port number.

comment:11 Changed 7 years ago by arma

I think the recommended torrc lines are wrong. E.g., the bridge shouldn't be setting usebridges 1, and "exitpolicy *.*" makes no sense (and even less sense for clients).

Changed 7 years ago by marlowe

Fixes for comment #11

comment:12 Changed 7 years ago by Sebastian

committed obfsproxy-instructions-update.patch

Changed 7 years ago by asn

Attachment: patch.2 added

comment:13 Changed 7 years ago by asn

Status: newneeds_review

patch.2 is a patch which strips not-transport-related lines from the sample torrc, and fixes some other minor things too.

comment:14 Changed 7 years ago by arma

Looks like sebastian committed patch.2 as r25357.

comment:15 Changed 7 years ago by arma

Resolution: implemented
Status: needs_reviewclosed

I'm going to close this ticket: there is an obfsproxy project page on the website.

Any further tickets could be things like "other things we should do with the page" and "problems with the page".

Note: See TracTickets for help on using tickets.