April 2013 - tor-commits - lists.torproject.org

[translation/tsum_completed] Update translations for tsum_completed
by translation＠torproject.org 15 Apr '13

15 Apr '13

commit c564008bc73d836676007409f85eff7e840cecc1 Author: Translation commit bot <translation(a)torproject.org> Date: Mon Apr 15 20:45:16 2013 +0000 Update translations for tsum_completed --- zh_CN/short-user-manual_zh_CN_noimg.xhtml | 6 +++--- 1 files changed, 3 insertions(+), 3 deletions(-) diff --git a/zh_CN/short-user-manual_zh_CN_noimg.xhtml b/zh_CN/short-user-manual_zh_CN_noimg.xhtml index f9cf8e9..1425671 100644 --- a/zh_CN/short-user-manual_zh_CN_noimg.xhtml +++ b/zh_CN/short-user-manual_zh_CN_noimg.xhtml @@ -67,9 +67,9 @@ sub 2048R/EB399FD7 2003-10-16 有时，在尝试连接 Tor 网络时 Vidalia 会停滞不前。如果出现这种情况，请确保你已连接到互联网。如需通过代理服务器连接，请参阅下面的 “如何使用代理服务器”。 如果互联网连接正常但 Tor 无法连接到网络，请尝试以下操作：打开 Vidalia 控制面板，点击“消息日志”，然后选择“高级”标签页。Tor 网络无法连接的原因可能在于： 你的系统时钟不准确：请确保你系统中的日期和时间正确，然后重启 Tor。你也许需要把系统时钟与网络时间服务器进行同步。 - 你受限于防火墙软件：让 Tor 仅尝试 80 和 443 端口，打开 Vidalia 控制面板，点击 设置，网络，然后选中 我的防火墙只允许我连接到指定端口 的选项框。 - 你的反病毒软件正在阻挡 Tor：请确保你的反病毒软件没有阻止 Tor 进行网络连接。 - 如果 Tor 仍然不能工作，那么可能是你的互联网服务提供商（ISP）正在阻挡 Tor。这通常可以使用 Tor 网桥 —— 不易被阻挡的隐蔽中继服务器，来绕开阻挡。 + 防火墙限制：为了让 Tor 仅使用 80 和 443 端口，请打开 Vidalia 控制面板，点击 设置 > 网络，然后选中防火墙仅允许连接某些端口。 + 杀毒软件封锁 Tor：请确保杀毒软件没有封锁 Tor 网络连接。 + 如果 Tor 仍然无法正常运行，可能是互联网服务提供商 (ISP) 封锁了 Tor。很多时候，可使用不易被封锁的隐藏中继 Tor 网桥来突破封锁。 如何你需要帮助去判断为什么 Tor 无法连接，请发送电子邮件到 help(a)rt.torproject.org ，并附上日志文件的相关部分内容。 <h3 id="how-to-find-a-bridge">如何查找网桥</h3> 要使用网桥，你首先需要找一个。你可以浏览 <a href="https://bridges.torproject.org/">bridges.torproject.org</a> ，或者发送电子邮件到 bridges(a)torproject.org 。如果发送电子邮件，请你确保在电子邮件的正文区域内写上 get bridges。否则你将得不到回复。请注意你只能使用 gmail.com 或 yahoo.com 邮箱来发送此邮件。

1 0

[translation/tsum] Update translations for tsum
by translation＠torproject.org 15 Apr '13

15 Apr '13

commit d1184f2937826676ed4dc692b0cdd082fafd6335 Author: Translation commit bot <translation(a)torproject.org> Date: Mon Apr 15 20:45:13 2013 +0000 Update translations for tsum --- zh_CN/short-user-manual_zh_CN_noimg.xhtml | 6 +++--- 1 files changed, 3 insertions(+), 3 deletions(-) diff --git a/zh_CN/short-user-manual_zh_CN_noimg.xhtml b/zh_CN/short-user-manual_zh_CN_noimg.xhtml index f9cf8e9..1425671 100644 --- a/zh_CN/short-user-manual_zh_CN_noimg.xhtml +++ b/zh_CN/short-user-manual_zh_CN_noimg.xhtml @@ -67,9 +67,9 @@ sub 2048R/EB399FD7 2003-10-16 有时，在尝试连接 Tor 网络时 Vidalia 会停滞不前。如果出现这种情况，请确保你已连接到互联网。如需通过代理服务器连接，请参阅下面的 “如何使用代理服务器”。 如果互联网连接正常但 Tor 无法连接到网络，请尝试以下操作：打开 Vidalia 控制面板，点击“消息日志”，然后选择“高级”标签页。Tor 网络无法连接的原因可能在于： 你的系统时钟不准确：请确保你系统中的日期和时间正确，然后重启 Tor。你也许需要把系统时钟与网络时间服务器进行同步。 - 你受限于防火墙软件：让 Tor 仅尝试 80 和 443 端口，打开 Vidalia 控制面板，点击 设置，网络，然后选中 我的防火墙只允许我连接到指定端口 的选项框。 - 你的反病毒软件正在阻挡 Tor：请确保你的反病毒软件没有阻止 Tor 进行网络连接。 - 如果 Tor 仍然不能工作，那么可能是你的互联网服务提供商（ISP）正在阻挡 Tor。这通常可以使用 Tor 网桥 —— 不易被阻挡的隐蔽中继服务器，来绕开阻挡。 + 防火墙限制：为了让 Tor 仅使用 80 和 443 端口，请打开 Vidalia 控制面板，点击 设置 > 网络，然后选中防火墙仅允许连接某些端口。 + 杀毒软件封锁 Tor：请确保杀毒软件没有封锁 Tor 网络连接。 + 如果 Tor 仍然无法正常运行，可能是互联网服务提供商 (ISP) 封锁了 Tor。很多时候，可使用不易被封锁的隐藏中继 Tor 网桥来突破封锁。 如何你需要帮助去判断为什么 Tor 无法连接，请发送电子邮件到 help(a)rt.torproject.org ，并附上日志文件的相关部分内容。 <h3 id="how-to-find-a-bridge">如何查找网桥</h3> 要使用网桥，你首先需要找一个。你可以浏览 <a href="https://bridges.torproject.org/">bridges.torproject.org</a> ，或者发送电子邮件到 bridges(a)torproject.org 。如果发送电子邮件，请你确保在电子邮件的正文区域内写上 get bridges。否则你将得不到回复。请注意你只能使用 gmail.com 或 yahoo.com 邮箱来发送此邮件。

1 0

[translation/tsum_completed] Update translations for tsum_completed
by translation＠torproject.org 15 Apr '13

15 Apr '13

commit 7817a26dda096b113cd66c5d97189f7c337079dc Author: Translation commit bot <translation(a)torproject.org> Date: Mon Apr 15 20:15:17 2013 +0000 Update translations for tsum_completed --- zh_CN/short-user-manual_zh_CN_noimg.xhtml | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/zh_CN/short-user-manual_zh_CN_noimg.xhtml b/zh_CN/short-user-manual_zh_CN_noimg.xhtml index c908b89..f9cf8e9 100644 --- a/zh_CN/short-user-manual_zh_CN_noimg.xhtml +++ b/zh_CN/short-user-manual_zh_CN_noimg.xhtml @@ -65,8 +65,8 @@ sub 2048R/EB399FD7 2003-10-16 <h3 id="what-to-do-when-tor-does-not-connect">当 Tor 无法连接时怎么办</h3> 有时，在尝试连接 Tor 网络时 Vidalia 会停滞不前。如果出现这种情况，请确保你已连接到互联网。如需通过代理服务器连接，请参阅下面的 “如何使用代理服务器”。 - 如果你的普通互联网连接运作正常，而 Tor 却无法连接到网络，请尝试以下步骤：打开 Vidalia 的控制面板，点击 消息日志 并选择 高级 标签页。Tor 无法连接到网络也许是因为： - 你的系统时钟不准确：请确保你系统中的日期和时间正确，然后重启 Tor。你也许需要把系统时钟与某台网络时间服务器进行同步。 + 如果互联网连接正常但 Tor 无法连接到网络，请尝试以下操作：打开 Vidalia 控制面板，点击“消息日志”，然后选择“高级”标签页。Tor 网络无法连接的原因可能在于： + 你的系统时钟不准确：请确保你系统中的日期和时间正确，然后重启 Tor。你也许需要把系统时钟与网络时间服务器进行同步。 你受限于防火墙软件：让 Tor 仅尝试 80 和 443 端口，打开 Vidalia 控制面板，点击 设置，网络，然后选中 我的防火墙只允许我连接到指定端口 的选项框。 你的反病毒软件正在阻挡 Tor：请确保你的反病毒软件没有阻止 Tor 进行网络连接。 如果 Tor 仍然不能工作，那么可能是你的互联网服务提供商（ISP）正在阻挡 Tor。这通常可以使用 Tor 网桥 —— 不易被阻挡的隐蔽中继服务器，来绕开阻挡。

1 0

[translation/tsum] Update translations for tsum
by translation＠torproject.org 15 Apr '13

15 Apr '13

commit daefb4a385f28ed84714549cd3ac17cad84aac5a Author: Translation commit bot <translation(a)torproject.org> Date: Mon Apr 15 20:15:14 2013 +0000 Update translations for tsum --- zh_CN/short-user-manual_zh_CN_noimg.xhtml | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/zh_CN/short-user-manual_zh_CN_noimg.xhtml b/zh_CN/short-user-manual_zh_CN_noimg.xhtml index c908b89..f9cf8e9 100644 --- a/zh_CN/short-user-manual_zh_CN_noimg.xhtml +++ b/zh_CN/short-user-manual_zh_CN_noimg.xhtml @@ -65,8 +65,8 @@ sub 2048R/EB399FD7 2003-10-16 <h3 id="what-to-do-when-tor-does-not-connect">当 Tor 无法连接时怎么办</h3> 有时，在尝试连接 Tor 网络时 Vidalia 会停滞不前。如果出现这种情况，请确保你已连接到互联网。如需通过代理服务器连接，请参阅下面的 “如何使用代理服务器”。 - 如果你的普通互联网连接运作正常，而 Tor 却无法连接到网络，请尝试以下步骤：打开 Vidalia 的控制面板，点击 消息日志 并选择 高级 标签页。Tor 无法连接到网络也许是因为： - 你的系统时钟不准确：请确保你系统中的日期和时间正确，然后重启 Tor。你也许需要把系统时钟与某台网络时间服务器进行同步。 + 如果互联网连接正常但 Tor 无法连接到网络，请尝试以下操作：打开 Vidalia 控制面板，点击“消息日志”，然后选择“高级”标签页。Tor 网络无法连接的原因可能在于： + 你的系统时钟不准确：请确保你系统中的日期和时间正确，然后重启 Tor。你也许需要把系统时钟与网络时间服务器进行同步。 你受限于防火墙软件：让 Tor 仅尝试 80 和 443 端口，打开 Vidalia 控制面板，点击 设置，网络，然后选中 我的防火墙只允许我连接到指定端口 的选项框。 你的反病毒软件正在阻挡 Tor：请确保你的反病毒软件没有阻止 Tor 进行网络连接。 如果 Tor 仍然不能工作，那么可能是你的互联网服务提供商（ISP）正在阻挡 Tor。这通常可以使用 Tor 网桥 —— 不易被阻挡的隐蔽中继服务器，来绕开阻挡。

1 0

[translation/tsum_completed] Update translations for tsum_completed
by translation＠torproject.org 15 Apr '13

15 Apr '13

commit 7f63927a6b4034fd63c8942f00e208629203738c Author: Translation commit bot <translation(a)torproject.org> Date: Mon Apr 15 19:45:23 2013 +0000 Update translations for tsum_completed --- zh_CN/short-user-manual_zh_CN_noimg.xhtml | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/zh_CN/short-user-manual_zh_CN_noimg.xhtml b/zh_CN/short-user-manual_zh_CN_noimg.xhtml index b887f18..c908b89 100644 --- a/zh_CN/short-user-manual_zh_CN_noimg.xhtml +++ b/zh_CN/short-user-manual_zh_CN_noimg.xhtml @@ -64,7 +64,7 @@ sub 2048R/EB399FD7 2003-10-16 请注意：务必使用该软件包附带的浏览器，而不是用户自己安装的浏览器。这点至关重要。 <h3 id="what-to-do-when-tor-does-not-connect">当 Tor 无法连接时怎么办</h3> - 有些用户会遇到 Vidalia 在尝试连接到 Tor 网络时卡住不动的情况。遇到这种情况，请确保你已连接到互联网。如果你需要通过代理服务器连接，请参阅下面的 “如何使用代理服务器”。 + 有时，在尝试连接 Tor 网络时 Vidalia 会停滞不前。如果出现这种情况，请确保你已连接到互联网。如需通过代理服务器连接，请参阅下面的 “如何使用代理服务器”。 如果你的普通互联网连接运作正常，而 Tor 却无法连接到网络，请尝试以下步骤：打开 Vidalia 的控制面板，点击 消息日志 并选择 高级 标签页。Tor 无法连接到网络也许是因为： 你的系统时钟不准确：请确保你系统中的日期和时间正确，然后重启 Tor。你也许需要把系统时钟与某台网络时间服务器进行同步。 你受限于防火墙软件：让 Tor 仅尝试 80 和 443 端口，打开 Vidalia 控制面板，点击 设置，网络，然后选中 我的防火墙只允许我连接到指定端口 的选项框。

1 0

[translation/tsum] Update translations for tsum
by translation＠torproject.org 15 Apr '13

15 Apr '13

commit 777a2d4bccb542bbdc88e5245eddbdb353190532 Author: Translation commit bot <translation(a)torproject.org> Date: Mon Apr 15 19:45:19 2013 +0000 Update translations for tsum --- zh_CN/short-user-manual_zh_CN_noimg.xhtml | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/zh_CN/short-user-manual_zh_CN_noimg.xhtml b/zh_CN/short-user-manual_zh_CN_noimg.xhtml index b887f18..c908b89 100644 --- a/zh_CN/short-user-manual_zh_CN_noimg.xhtml +++ b/zh_CN/short-user-manual_zh_CN_noimg.xhtml @@ -64,7 +64,7 @@ sub 2048R/EB399FD7 2003-10-16 请注意：务必使用该软件包附带的浏览器，而不是用户自己安装的浏览器。这点至关重要。 <h3 id="what-to-do-when-tor-does-not-connect">当 Tor 无法连接时怎么办</h3> - 有些用户会遇到 Vidalia 在尝试连接到 Tor 网络时卡住不动的情况。遇到这种情况，请确保你已连接到互联网。如果你需要通过代理服务器连接，请参阅下面的 “如何使用代理服务器”。 + 有时，在尝试连接 Tor 网络时 Vidalia 会停滞不前。如果出现这种情况，请确保你已连接到互联网。如需通过代理服务器连接，请参阅下面的 “如何使用代理服务器”。 如果你的普通互联网连接运作正常，而 Tor 却无法连接到网络，请尝试以下步骤：打开 Vidalia 的控制面板，点击 消息日志 并选择 高级 标签页。Tor 无法连接到网络也许是因为： 你的系统时钟不准确：请确保你系统中的日期和时间正确，然后重启 Tor。你也许需要把系统时钟与某台网络时间服务器进行同步。 你受限于防火墙软件：让 Tor 仅尝试 80 和 443 端口，打开 Vidalia 控制面板，点击 设置，网络，然后选中 我的防火墙只允许我连接到指定端口 的选项框。

1 0

[translation/tsum_completed] Update translations for tsum_completed
by translation＠torproject.org 15 Apr '13

15 Apr '13

commit e893706878b6f59db270677aa02e0c2a74d7cdd1 Author: Translation commit bot <translation(a)torproject.org> Date: Mon Apr 15 18:15:16 2013 +0000 Update translations for tsum_completed --- zh_CN/short-user-manual_zh_CN_noimg.xhtml | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/zh_CN/short-user-manual_zh_CN_noimg.xhtml b/zh_CN/short-user-manual_zh_CN_noimg.xhtml index c9b1a0b..b887f18 100644 --- a/zh_CN/short-user-manual_zh_CN_noimg.xhtml +++ b/zh_CN/short-user-manual_zh_CN_noimg.xhtml @@ -59,9 +59,9 @@ sub 2048R/EB399FD7 2003-10-16 当你已完成验证并且输出结果是 Good signature，请把软件包解压缩，然后你应该会看到一个类似 tor-browser_en-US 这样的文件夹。此文件夹包含一个名为 Docs 的文件夹，其中有一个 changelog 文件。请确保 changelog 里第一行的版本号与文件名中的版本号相符。 <h3 id="how-to-use-the-tor-browser-bundle">如何使用 Tor Browser Bundle</h3> 下载 Tor Browser Bundle 并提取文件之后，将会出现一个包含几个文件的文件夹。其中包含一个可执行文件，文件名为“Start Tor Browser“（或”start-tor-browser“，这取决于你的操作系统）。 - 运行 Tor Browser Bundle 时，首先启动 Vidalia 启动将用户连接到 Tor 网络，然后在浏览器打开 <a href="https://check.torproject.org/">https://check.torproject.org/</a>，确认你正在使用 Tor。现在你可以开始通过 Tor 来浏览互联网了。 + 运行 Tor Browser Bundle 时，首先启动 Vidalia 与 Tor 网络建立连接，成功连接之后将打开 <a href="https://check.torproject.org/">https://check.torproject.org/</a> 页面，以确认用户正在使用 Tor 网络。这时，用户即可开始通过 Tor 访问互联网。 - 请注意：务必使用该软件包附带的浏览器，不可使用用户自己安装的浏览器。这点至关重要。 + 请注意：务必使用该软件包附带的浏览器，而不是用户自己安装的浏览器。这点至关重要。 <h3 id="what-to-do-when-tor-does-not-connect">当 Tor 无法连接时怎么办</h3> 有些用户会遇到 Vidalia 在尝试连接到 Tor 网络时卡住不动的情况。遇到这种情况，请确保你已连接到互联网。如果你需要通过代理服务器连接，请参阅下面的 “如何使用代理服务器”。

1 0

[translation/tsum] Update translations for tsum
by translation＠torproject.org 15 Apr '13

15 Apr '13

commit 40c9dd088ab65fd652b194dde27d2af662ddb02e Author: Translation commit bot <translation(a)torproject.org> Date: Mon Apr 15 18:15:14 2013 +0000 Update translations for tsum --- zh_CN/short-user-manual_zh_CN_noimg.xhtml | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/zh_CN/short-user-manual_zh_CN_noimg.xhtml b/zh_CN/short-user-manual_zh_CN_noimg.xhtml index c9b1a0b..b887f18 100644 --- a/zh_CN/short-user-manual_zh_CN_noimg.xhtml +++ b/zh_CN/short-user-manual_zh_CN_noimg.xhtml @@ -59,9 +59,9 @@ sub 2048R/EB399FD7 2003-10-16 当你已完成验证并且输出结果是 Good signature，请把软件包解压缩，然后你应该会看到一个类似 tor-browser_en-US 这样的文件夹。此文件夹包含一个名为 Docs 的文件夹，其中有一个 changelog 文件。请确保 changelog 里第一行的版本号与文件名中的版本号相符。 <h3 id="how-to-use-the-tor-browser-bundle">如何使用 Tor Browser Bundle</h3> 下载 Tor Browser Bundle 并提取文件之后，将会出现一个包含几个文件的文件夹。其中包含一个可执行文件，文件名为“Start Tor Browser“（或”start-tor-browser“，这取决于你的操作系统）。 - 运行 Tor Browser Bundle 时，首先启动 Vidalia 启动将用户连接到 Tor 网络，然后在浏览器打开 <a href="https://check.torproject.org/">https://check.torproject.org/</a>，确认你正在使用 Tor。现在你可以开始通过 Tor 来浏览互联网了。 + 运行 Tor Browser Bundle 时，首先启动 Vidalia 与 Tor 网络建立连接，成功连接之后将打开 <a href="https://check.torproject.org/">https://check.torproject.org/</a> 页面，以确认用户正在使用 Tor 网络。这时，用户即可开始通过 Tor 访问互联网。 - 请注意：务必使用该软件包附带的浏览器，不可使用用户自己安装的浏览器。这点至关重要。 + 请注意：务必使用该软件包附带的浏览器，而不是用户自己安装的浏览器。这点至关重要。 <h3 id="what-to-do-when-tor-does-not-connect">当 Tor 无法连接时怎么办</h3> 有些用户会遇到 Vidalia 在尝试连接到 Tor 网络时卡住不动的情况。遇到这种情况，请确保你已连接到互联网。如果你需要通过代理服务器连接，请参阅下面的 “如何使用代理服务器”。

1 0

r26159: {website} Edit the obfsproxy instructions to use pip. (website/trunk/projects/en)
by George Kadianakis 15 Apr '13

15 Apr '13

Author: asn Date: 2013-04-15 17:50:34 +0000 (Mon, 15 Apr 2013) New Revision: 26159 Modified: website/trunk/projects/en/obfsproxy-instructions.wml Log: Edit the obfsproxy instructions to use pip. Modified: website/trunk/projects/en/obfsproxy-instructions.wml =================================================================== --- website/trunk/projects/en/obfsproxy-instructions.wml 2013-04-13 12:54:39 UTC (rev 26158) +++ website/trunk/projects/en/obfsproxy-instructions.wml 2013-04-15 17:50:34 UTC (rev 26159) @@ -24,19 +24,21 @@ Python version! - <h3>Step 0: Install dependencies</h3> + <h3>Step 0: Install Python</h3> - To setup obfsproxy you will need <code>git</code>, <code>Python</code> - (>= 2.7), <code>Twisted</code> and some common Python modules - (<code>setuptools</code>, <code>argparse</code> and <code>PyCrypto</code>) - . If you use Debian testing (or unstable), or a version of - Ubuntu newer than Oneiric, this is easy: + To setup obfsproxy you will need <code>Python</code> (>= 2.7), + and <code>pip</code>. If you use Debian testing (or unstable), + or a version of Ubuntu newer than Oneiric, this is easy: - <tt># apt-get install git python2.7 python-setuptools python-crypto python-twisted python-argparse</tt> + <tt># apt-get install python2.7 python-pip</tt> + + <h3>Step 1: Install Tor</h3> + + You will also need a recent version of Tor (>= 0.2.4.1). We recommend you use <a href="<page docs/debian>#development">Tor's experimental repositories for Debian/Ubuntu</a> @@ -44,55 +46,34 @@ <a href="https://gitweb.torproject.org/tor.git">install Tor from git</a>. - <h3>Step 1: Install pyptlib</h3> - - - You will also need pyptlib, a small library developed by the Tor - Project for writing pluggable transports. + You need Tor 0.2.4.x because it knows how to automatically report + your obfsproxy address to BridgeDB. - <tt>$ git clone https://git.torproject.org/pluggable-transports/pyptlib.git</tt> - <tt>$ cd pyptlib && python setup.py install</tt> - - - You might need to run the python setup.py install - command as root. If you don't want to run it as root, you can - use python setup.py install --user which will install pyptlib - just for the current user. - - - <h3>Step 2: Install and test obfsproxy</h3> + <h3>Step 2: Install obfsproxy</h3> - Now it's time to fetch obfsproxy and test that it works: + If you have <code>pip</code>, installing <code>obfsproxy</code> + and its dependencies should be a matter of a single command: - <tt>$ git clone https://git.torproject.org/pluggable-transports/obfsproxy.git</tt> - <tt>$ cd obfsproxy</tt> - <tt>$ python obfsproxy/test/tester.py</tt> + <tt># pip install obfsproxy</tt> - If you got a message reporting that all tests finished successfully, - then obfsproxy works for you. Time to run the setup.py script so that - obfsproxy gets installed in your system: + You will probably want to run the pip install command as + root so that obfsproxy gets installed to /usr/local/bin. - <tt># python setup.py install</tt> + <h3>Step 3: Setup tor</h3> + - You will probably want to run the setup.py script as root so that obfsproxy gets installed in /usr/local/bin. + Now setup Tor. Edit your /etc/tor/torrc to add: - <h3>Step 3: Setup tor</h3> - - - Edit your /etc/tor/torrc to add: - - - <tt>SocksPort 0</tt> <tt>ORPort 443 # or some other port if you already run a webserver/skype</tt> <tt>BridgeRelay 1</tt>

1 0

[stem/master] Adding a FAQ page
by atagar＠torproject.org 15 Apr '13

15 Apr '13

commit 6b7b50c5c7834f76ddba0a78f337a5f1e4998599 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Apr 15 09:29:32 2013 -0700 Adding a FAQ page Introducing a page with FAQ items for the most common questions that I've seen so far. Suggested by gsathya on... https://trac.torproject.org/8577 --- docs/_static/buttons/faq.png | Bin 0 -> 13817 bytes docs/_static/buttons/resources/faq.xcf | Bin 0 -> 56361 bytes docs/_templates/layout.html | 1 + docs/contents.rst | 1 + docs/faq.rst | 152 ++++++++++++++++++++++++++++++++ docs/index.rst | 29 +++++-- 6 files changed, 175 insertions(+), 8 deletions(-) diff --git a/docs/_static/buttons/faq.png b/docs/_static/buttons/faq.png new file mode 100644 index 0000000..6333bc9 Binary files /dev/null and b/docs/_static/buttons/faq.png differ diff --git a/docs/_static/buttons/resources/faq.xcf b/docs/_static/buttons/resources/faq.xcf new file mode 100644 index 0000000..370ed89 Binary files /dev/null and b/docs/_static/buttons/resources/faq.xcf differ diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index e0cc749..f02d4e5 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -46,6 +46,7 @@ </li> <li><a href="https://trac.torproject.org/projects/tor/wiki/doc/stem">Development</a> <ul> + <li><a href="{{ pathto('faq') }}">FAQ</a></li> <li><a href="{{ pathto('change_log') }}">Change Log</a></li> <li><a href="https://trac.torproject.org/projects/tor/wiki/doc/stem/bugs">Bug Tracker</a></li> <li><a href="{{ pathto('download') }}">Download</a></li> diff --git a/docs/contents.rst b/docs/contents.rst index be34d8f..834ce0a 100644 --- a/docs/contents.rst +++ b/docs/contents.rst @@ -14,6 +14,7 @@ Contents change_log download + faq api api/control diff --git a/docs/faq.rst b/docs/faq.rst new file mode 100644 index 0000000..43edba8 --- /dev/null +++ b/docs/faq.rst @@ -0,0 +1,152 @@ +Frequently Asked Questions +========================== + +* **Usage** + + * :ref:`what_is_stem` + * :ref:`does_stem_have_any_dependencies` + * :ref:`what_python_versions_is_stem_compatible_with` + * :ref:`what_license_is_stem_under` + * :ref:`where_can_i_get_help` + +* **Development** + + * :ref:`how_do_i_get_started` + * :ref:`how_do_i_run_the_tests` + * :ref:`how_do_i_build_the_site` + * :ref:`what_is_the_copyright_for_patches` + +Usage +----- + +.. _what_is_stem: + +What is stem? +^^^^^^^^^^^^^ + +Stem is a python controller library that you can use to interact with `tor <https://www.torproject.org/>`_. With it you can write scripts and applications with capabilities similar to `Vidalia <https://www.torproject.org/getinvolved/volunteer.html.en#project-vidalia>`_ and `arm <http://www.atagar.com/arm/>`_. + +From a technical standpoint, stem is a python implementation of Tor's `directory <https://gitweb.torproject.org/torspec.git/blob/HEAD:/dir-spec.txt>`_ and `control specifications <https://gitweb.torproject.org/torspec.git/blob/HEAD:/control-spec.txt>`_. `To get started see our tutorials! <tutorials.html>`_ + +.. _does_stem_have_any_dependencies: + +Does stem have any dependencies? +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**No.** All you need in order to use stem is python. + +When it is available stem will use `pycrypto <https://www.dlitz.net/software/pycrypto/>`_ to validate descriptor signatures. However, there is no need to install pycrypto unless you need this functionality. + +.. _what_python_versions_is_stem_compatible_with: + +What python versions is stem compatible with? +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Stem works with **python 2.6 and greater**. This includes the python 3.x series by installing stem via python3 (see our `installation instructions <https://pypi.python.org/pypi/stem/>`_ for more information). + +.. _what_license_is_stem_under: + +What license is stem under? +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Stem is under the `LGPLv3 <https://www.gnu.org/licenses/lgpl>`_. + +.. _where_can_i_get_help: + +Where can I get help? +^^^^^^^^^^^^^^^^^^^^^ + +Do you have a tor related question or project that you would like to discuss? If so then find us on the `tor-dev@ email list <https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-dev>`_ and `IRC <https://www.torproject.org/about/contact.html.en#irc>`_. + +Development +----------- + +.. _how_do_i_get_started: + +How do I get started? +^^^^^^^^^^^^^^^^^^^^^ + +The best way of getting involved with any project is to jump right in! Our `bug tracker <https://trac.torproject.org/projects/tor/wiki/doc/stem/bugs>`_ lists several development tasks. In particular look for the 'easy' keyword when getting started. + +If you have any questions then I'm always more than happy to help (I'm **atagar** on `oftc <http://www.oftc.net/oftc/>`_ and also available `via email <http://www.atagar.com/contact/>`_). + +To start hacking on stem please do the following and don't hesitate to let me know if you get stuck or would like to discuss anything! + +1. Clone our `git <http://git-scm.com/>`_ repository: **git clone https://git.torproject.org/stem.git** +2. Find a `bug or feature <https://trac.torproject.org/projects/tor/wiki/doc/stem/bugs>`_ that sounds interesting. +3. When you have something that you would like to contribute back do the following... + + * If you don't already have a publicly accessible stem repository then set one up. `GitHub <https://github.com/>`_ in particular is great for this. + * File a `trac ticket <https://trac.torproject.org/projects/tor/newticket>`_, the only fields you'll need are... + + * Summary: short description of your change + * Description: longer description and a link to your repository with either the git commits or branch that has your change + * Type: 'defect' if this is a bug fix and 'enhancement' otherwise + * Priority: rough guess at the priority of your change + * Component: Stem + + * I'll review the change and give suggestions. When we're both happy with it I'll push your change to the official repository. + +.. _how_do_i_run_the_tests: + +How do I run the tests? +^^^^^^^^^^^^^^^^^^^^^^^ + +Stem has three kinds of tests: **unit**, **integration**, and **static**. + +**Unit** tests are our most frequently ran tests. They're quick, they're easy, and provide good test coverage... + +:: + + ~$ cd stem/ + ~/stem$ ./run_tests.py --unit + +**Integration** tests start a live tor instance and test against that. This not only provides additional test coverage, but lets us check our continued interoperability with new releases of tor. Running these require that you have `tor installed <https://www.torproject.org/download/download.html.en>`_. You can exercise alternate tor configurations with the ``--target`` argument (see ``run_tests.py --help`` for a list of its options). + +:: + + ~/stem$ ./run_tests.py --integ + ~/stem$ ./run_tests.py --integ --tor /path/to/tor + ~/stem$ ./run_tests.py --integ --target RUN_COOKIE + +**Static** tests use `pyflakes <https://launchpad.net/pyflakes>`_ to do static error checking and `pep8 <http://pep8.readthedocs.org/en/latest/>`_ for style checking. If you have them installed then pyflakes automatically takes place as part of all test runs, but static checking is run separately... + +:: + + ~/stem$ ./run_tests.py --style + +If you have **python 3** installed then you can test our python 3 compatibility with the following. *Note that need to still initially execute run_tests.py with a 2.x version of python.* + +:: + + ~/stem$ ./run_tests.py --all --python3 + +See ``run_tests.py --help`` for more usage information. + +.. _how_do_i_build_the_site: + +How do I build the site? +^^^^^^^^^^^^^^^^^^^^^^^^ + +If you have `sphinx <http://sphinx-doc.org/>`_ version 1.1 or later installed then building our site is as easy as... + +:: + + ~$ cd stem/docs + ~/stem/docs$ make html + +When it's finished you can direct your browser to the *_build* directory with a URI similar to... + +:: + + file:///home/atagar/stem/docs/_build/html/index.html + +.. _what_is_the_copyright_for_patches: + +What is the copyright for patches? +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Stem is under the LGPLv3 which is a fine license, but poses a bit of a problem for sharing code with our other projects (which are mostly BSD). To share code without needing to hunt down prior contributors we need an individual to have the copyright for the whole stem codebase. This is Damian at present, but I'll probably give it to Tor if I get nailed by a bus. + +If you submit a substantial patch I'll ask if you're fine with it being in the public domain. This would mean that there are no legal restrictions for using your contribution, and hence won't pose a problem if we reuse stem code in other projects. + diff --git a/docs/index.rst b/docs/index.rst index b01bb36..734b684 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -27,15 +27,20 @@ Stem is a python controller library for `Tor <https://www.torproject.org/>`_. Li .. image:: /_static/buttons/api.png :target: api.html -.. Source: Crystal (http://www.everaldo.com/crystal/) - Author: Everaldo Coelho (http://www.everaldo.com/) - License: LGPL v2 - File: Crystal/64x64/apps/bug.png +.. Source: https://openclipart.org/detail/171951/help-by-diamonjohn-171951 + Author: John Diamond (https://openclipart.org/user-detail/diamonjohn) + License: Public Domain + + Alternate: + Source: Oxygen (http://www.oxygen-icons.org/) + Author: Andrea Joseph + License: CCv3 (A, SA) - http://creativecommons.org/licenses/by-sa/3.0/ + File: Oxygen/128x128/categories/system-help.png -.. image:: /_static/buttons/bug_tracker.png - :target: https://trac.torproject.org/projects/tor/wiki/doc/stem/bugs +.. image:: /_static/buttons/faq.png + :target: faq.html -.. Nuovo (http://www.silvestre.com.ar/?p=5) +.. Source: Nuovo (http://www.silvestre.com.ar/?p=5) Author: Silvestre Herrera (http://www.silvestre.com.ar/) License: GPL v2 File: Nuovo/128x128/mimetypes/gnome-mime-text-log.png @@ -43,7 +48,15 @@ Stem is a python controller library for `Tor <https://www.torproject.org/>`_. Li .. image:: /_static/buttons/change_log.png :target: change_log.html -.. ColorCons (http://mouserunner.com/Spheres_ColoCons1_Free_Icons.html) +.. Source: Crystal (http://www.everaldo.com/crystal/) + Author: Everaldo Coelho (http://www.everaldo.com/) + License: LGPL v2 + File: Crystal/64x64/apps/bug.png + +.. image:: /_static/buttons/bug_tracker.png + :target: https://trac.torproject.org/projects/tor/wiki/doc/stem/bugs + +.. Source: ColorCons (http://mouserunner.com/Spheres_ColoCons1_Free_Icons.html) Author: Ken Saunders (http://mouserunner.com/MRDS_Cell.html) License: CC v2.5 (A, SA) File: ColorCons/Blue/Download.png

1 0