mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-28 08:03:36 +00:00
4064d6e231
Closes #930 - Make targets to download wiki pages of each service - Add post-processor script for DocBook file processing Signed-off-by: Joseph Nuthalapati <njoseph@thoughtworks.com> Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
219 lines
10 KiB
XML
219 lines
10 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
|
|
<article>
|
|
<articleinfo>
|
|
<title>FreedomBox/Manual/Shadowsocks</title>
|
|
<revhistory>
|
|
<revision>
|
|
<revnumber>1</revnumber>
|
|
<date>2018-01-04 19:59:57</date>
|
|
<authorinitials>David Jones</authorinitials>
|
|
</revision>
|
|
</revhistory>
|
|
</articleinfo>
|
|
<section>
|
|
<title>SOCKS5 proxy (Shadowsocks)</title>
|
|
<section>
|
|
<title>What is Shadowsocks?</title>
|
|
<para><ulink url="https://shadowsocks.org/en/index.html">Shadowsocks</ulink> is a lightweight and secure SOCKS5 proxy, designed to protect your Internet traffic. It can be used to bypass Internet filtering and censorship. Your <ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox#">FreedomBox</ulink> can run a Shadowsocks client which can connect to a Shadowsocks server. It will also run a SOCKS5 proxy. Local devices can connect to this proxy, and their data will be encrypted and proxied through the Shadowsocks server. </para>
|
|
<para><emphasis role="strong">Note:</emphasis> Shadowsocks is available in FreedomBox starting with Plinth version 0.18. </para>
|
|
</section>
|
|
<section>
|
|
<title>Using the Shadowsocks client?</title>
|
|
<para>The current implementation of Shadowsocks in <ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox#">FreedomBox</ulink> only supports configuring <ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox#">FreedomBox</ulink> as a Shadowsocks client. The current use case for Shadowsocks is as follows: </para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>Shadowsocks client (<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox#">FreedomBox</ulink>) is in a region where some parts of the Internet are blocked or censored. </para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Shadowsocks server is in a different region, which doesn't have these blocks. </para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>The <ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox#">FreedomBox</ulink> provides SOCKS proxy service on the local network for other devices to make use of its Shadowsocks connection. </para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<para>At a future date it will be possible to configure <ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox#">FreedomBox</ulink> as Shadowsocks server. </para>
|
|
</section>
|
|
<section>
|
|
<title>Configuring your FreedomBox for the Shadowsocks client</title>
|
|
<para>To enable Shadowsocks, first navigate to the Socks5 Proxy (Shadowsocks) page and install it. </para>
|
|
<para>Server: the Shadowsocks server is not the <ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox#">FreedomBox</ulink> IP or URL; rather, it will be another server or VPS that has been configured as a Shadowsocks server. There are also some public Shadowsocks servers listed on the web, but be aware that whoever operates the server can see where requests are going, and any non-encrypted data will be visible to them. </para>
|
|
<para>To use Shadowsocks after setup, set the SOCKS5 proxy URL in your device, browser or application to <ulink url="http://freedombox_address:1080/"/> </para>
|
|
<!--rule (<hr>) is not applicable to DocBook-->
|
|
<informaltable>
|
|
<tgroup cols="8">
|
|
<colspec colname="col_0"/>
|
|
<colspec colname="col_1"/>
|
|
<colspec colname="col_2"/>
|
|
<colspec colname="col_3"/>
|
|
<colspec colname="col_4"/>
|
|
<colspec colname="col_5"/>
|
|
<colspec colname="col_6"/>
|
|
<colspec colname="col_7"/>
|
|
<tbody>
|
|
<row rowsep="1">
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<emphasis role="strong">Information</emphasis>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1"/>
|
|
<entry colsep="1" rowsep="1"/>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<emphasis role="strong">Support</emphasis>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<emphasis role="strong">Work Space</emphasis>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1"/>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<emphasis role="strong">Reports</emphasis>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<emphasis role="strong">Promote</emphasis>
|
|
</para>
|
|
</entry>
|
|
</row>
|
|
<row rowsep="1">
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Introduction#">Overview</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Hardware#">Hardware</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<emphasis role="strong"> </emphasis>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Support#">Live Help</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Contribute#">Where To Start</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Translate#">Translate</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/ProgressCalls#">Calls</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/TalksAndPresentations#">Talks</ulink>
|
|
</para>
|
|
</entry>
|
|
</row>
|
|
<row rowsep="1">
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Features#">Features</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Vision#">Vision</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<emphasis role="strong"> </emphasis>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/QuestionsAndAnswers#">Q&A</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Design#">Design</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/TODO#">To Do</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Metrics#">Metrics</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Press#">Press</ulink>
|
|
</para>
|
|
</entry>
|
|
</row>
|
|
<row rowsep="1">
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Download#">Download</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Manual#">Manual</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<emphasis role="strong"> </emphasis>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/UserExperience#">Use cases</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Contribute/Code#">Code</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Contributors#">Contributors</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/ReleaseNotes#">Releases</ulink>
|
|
</para>
|
|
</entry>
|
|
<entry colsep="1" rowsep="1">
|
|
<para>
|
|
<ulink url="https://wiki.debian.org/FreedomBox/Manual/Shadowsocks/FreedomBox/Blog#">Blog</ulink>
|
|
</para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
<!--rule (<hr>) is not applicable to DocBook-->
|
|
<para>
|
|
</para>
|
|
</section>
|
|
</section>
|
|
</article>
|