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 9 GB of
21)     disk space, but this number can fluctuate. Expect space requirements
22)     of up to 15 GB.</p>

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

24)     <p>

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

26)     everything a mirror should share with the world:

27)     </p>

28)     <tt>

29) <pre>

30) rsync -aq --exclude dist --delete rsync://rsync.torproject.org/website-mirror/ /var/www/mirrors/torproject.org
31) rsync -aq --delete rsync://rsync.torproject.org/dist-mirror/ /var/www/mirrors/torproject.org/dist

32) </pre>

33)     </tt>

34) 

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

38) 

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

41) 

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

44) 

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

47) 

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

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

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

53) 

54)     </p>

55)     <br><br>

56)     <p>
57)     An example cronjob to update a full mirror once every 6 hours may look like so:

58)     </p>

59)     <tt>

60) <pre>
61) # m h  dom mon dow   command

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

63) 5 */6 * * * rsync -aq --delete rsync://rsync.torproject.org/dist-mirror/ /var/www/mirrors/torproject.org/dist
64) </pre>

65)     </tt>

66)     <p>

67)     For mirror operators that use Apache, we have created a sample virtual host
68)     configuration file to use:

69)     </p>

70)     <tt>

71) <pre>
72) &lt;VirtualHost 10.10.10.10:80&gt;

73)     ServerAdmin youremail@example.com<br/>
74)     ServerName  ServerNameHere<br/>

75) 

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

77) 

78)     &lt;Directory /var/www/mirrors/torproject.org/&gt;<br/>

79)         # Be sure to enable the autoindex and negotiation modules<br/>
80)         Options MultiViews Indexes<br/>

81)         DirectoryIndex index<br/>
82)         AllowOverride None<br/>
83)     &lt;/Directory&gt;<br/>

84) 

85) </VirtualHost>
86) </pre>

87)     </tt>

88)     <p>

89)     For mirror operators that use nginx, we created a sample virtual host
90)     configuration file to use:

91)     </p>

92)     <tt>

93) <pre>
94) server {
95)     listen 10.10.10.10:80;
96)     server_name your.example.com;

97) 

98)     root /var/www/mirrors/torproject.org;
99)     index index.html.en;

100) 

101)     location  / {
102)         autoindex on;

103)     }

104) }
105) </pre>

106)     </tt>

107)     <p>

108)     If you use nginx, please ensure the text/html line in

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

110)     </p>

111)     <tt>

112) <pre>
113) text/html                             en html htm shtml;
114) </pre>

115)     </tt>
116)     <br/><br>

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

121)     <br/>

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

123)     <p>

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

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

129) 

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

136)     confirmed. Some general pointers on mirrors are:

137)     <ol><li> Try not to run your mirror behind a content delivery network
138)     (such as Akamai, Cloudflare, Fastly, etc) as most of them block

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

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

142)     </ol>

143)     </p>
144)   </div>
145)   <!-- END MAINCOL -->
146)   <div id = "sidecol">
147) #include "side.wmi"
148) #include "info.wmi"
149)   </div>
150)   <!-- END SIDECOL -->
151) </div>
152) <!-- END CONTENT -->