tor-webwml.git

1) ## translation metadata

2) # Revision: $Revision$

3) # Translation-Priority: 4-optional
4) 
5) #include "head.wmi" TITLE="Tor: Running a Mirror" CHARSET="UTF-8"
6) <div id="content" class="clearfix">
7)   <div id="breadcrumbs">

8)     <a href="<page index>">Home &raquo; </a>

9)     <a href="<page docs/documentation>">Documentation &raquo; </a>
10)     <a href="<page docs/running-a-mirror>">Running a Mirror</a>

11)   </div>
12)   <div id="maincol">

13)     <h1>Tor: Running a Mirror</h1>

14)     <hr>

15) 

16)     <p>Thank you for wanting to mirror the Tor website.  All of
17)     our mirrors are publicly listed on <a href="<page getinvolved/mirrors>">our mirrors
18)     page</a>.  We've included some sample commands and configuration below
19)     to make the initial setup and ongoing maintenance a minimal effort.

20)     The Tor website and distribution directory currently require roughly 6 GB of

21)     disk space.</p>

22)     <h2><a class="anchor" href="#sysconfig">Configuring your System</a></h2>

23)     <p>

24)     If you would like to run a mirror, it's as easy as these commands to download

25)     everything a mirror should share with the world:

26)     <br> <br>

27)     <tt>

28)     rsync -av --exclude 'dist'--delete rsync://rsync.torproject.org/website-mirror tor-mirror/
29)     rsync -av --delete rsync://rsync.torproject.org/dist-mirror tor-mirror/dist/

30)     </tt>

31) 

32)     <p>
33)     In order to assure we have reliable and up to date mirrors,
34)     please ensure your mirror does at least the following:<br/><br/>

35) 

36)     Updates <b>no less</b> than every six hours, but no more frequent than every
37)     hour.<br/><br/>

38) 

39)     Allows "Directory Index / Indexes" (Index viewing) of the /dist
40)     directory.<br/><br/>

41) 

42)     Have a valid contact email for administrative communications should your
43)     server have issues.<br/><br/>

44) 

45)     It is highly recommended for all mirror operators to subscribe to <A

46)     href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-mirrors">tor-mirrors mailing

47)     list</A> where all mirror listing modification requests should go (ADD,
48)     CHANGE, DELETE, any other requests/notifications).  Also, any technical
49)     assistance in setting up your mirror may be found here as well.<br/><br/>

50) 

51)     </p>

52)     <br><br>

53)     <p>
54)     An example cronjob to update a full mirror once every 6 hours may look like so:
55)     <tt>
56)     <pre>
57)     # m h  dom mon dow   command

58)     0 */6 * * * rsync -aq --delete rsync://rsync.torproject.org/website-mirror/ /var/www/mirrors/torproject.org

59)     5 */6 * * * rsync -aq --delete rsync://rsync.torproject.org/dist-mirror/ /var/www/mirrors/torproject.org/dist

60)     </pre>
61)     </tt>
62)     </p>
63)     <br/>
64)     For mirror operators that use Apache, we have created a sample virtual host
65)     configuration file to use:
66)     <tt>
67)     <pre>

68)     <VirtualHost 10.10.10.10:80>

69)             ServerAdmin youremail@example.com<br/>

70)             ServerName  ServerNameHere<br/>

71) 

72)             DocumentRoot /var/www/mirrors/torproject.org<br/>

73) 

74)             &lt;Directory /var/www/mirrors/torproject.org/&gt;<br/>
75)                 Options MultiViews Indexes<br/>
76)                 DirectoryIndex index<br/>
77)                 AllowOverride None<br/>
78)             &lt;/Directory&gt;<br/>

79) 

80)     </VirtualHost>
81)     </pre>
82)     </tt>

83)     <br/>
84)     For mirror operators that use nginx, we created a sample virtual host
85)     configuration file to use:
86)     <tt>
87)     <pre>
88)     server {

89)     	listen 10.10.10.10:80;

90)   	server_name your.example.com;
91) 
92)   	root /var/www/mirrors/torproject.org;
93) 	index index.html.en;

94) 
95) 	location ^~ /dist/ {
96) 	  autoindex on;
97)       }

98)     }
99)     </pre>
100)     </tt>
101)     <br/>
102)     If you use nginx, please ensure the text/html line in

103)     <tt>/etc/nginx/mime.types</tt> matches:

104)     <tt>
105)     <pre>
106)     text/html                             en html htm shtml;
107)     </pre>
108)     </tt>
109)     <br/><br>

110)     Please ensure that you keep your mirror updated (we suggest automating this
111)     task with something like '<tt>cron</tt>'). Our website, source code and
112)     binary releases change often. An update frequency of six hours is recommended.  Tor users everywhere will thank you.
113)     </p>

114)     <br/>

115)     <h2><a class="anchor" href="#mirrorops">Joining the mirror community</a></h2>

116)     <p>

117)     If you are running a mirror, please subscribe to the <A
118)     href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-mirrors">tor-mirrors

119)     mailing list</A>, and introduce yourself there. Help for mirror
120)     support and configuration issues may also be found on the list.
121)     </p>

122) 

123)     <p>
124)     In order to add your mirror, please send a
125)     single, comma delimited line of text based on <a
126)     href="https://svn.torproject.org/svn/website/trunk/include/tor-mirrors.csv">this
127)     file</a> to the mirrors list. Your mirror will then be added manually
128)     if it passes availability testing and your provided information is

129)     confirmed. Some general pointers on mirrors are:
130)     <ol><li> Try not run your mirror behind a content delivery network

131)     (such as Akamai, Cloudflare, Fastly, etc), as most of them block

132)     access from countries where the mirror is needed the most.</li>
133)     <li> Try not to redirect http to https. Many places in the world

134)     cannot use https due to local or national firewalls.</li>

135)     </ol>

136)     </p>
137)   </div>
138)   <!-- END MAINCOL -->
139)   <div id = "sidecol">
140) #include "side.wmi"
141) #include "info.wmi"
142)   </div>
143)   <!-- END SIDECOL -->
144) </div>
145) <!-- END CONTENT -->