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

21)     30 GB of disk space, but this number can fluctuate. Expect space
22)     requirements of up to 50 GB.

23)     </p>

24)     <a id="sysconfig"></a>

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

26)     <p>

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

28)     everything a mirror should share with the world:

29)     </p>

30)     <tt>

31) <pre>

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

34) </pre>

35)     </tt>

36) 

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

40) 

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

43) 

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

46) 

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

49) 

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

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

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

55) 

56)     </p>

57)     <br><br>

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

60)     </p>

61)     <tt>

62) <pre>
63) # m h  dom mon dow   command

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

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

67)     </tt>

68)     <p>

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

71)     </p>

72)     <tt>

73) <pre>
74) &lt;VirtualHost 10.10.10.10:80&gt;

75)     ServerAdmin youremail@example.com<br/>
76)     ServerName  ServerNameHere<br/>

77) 

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

79) 

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

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

83)         DirectoryIndex index<br/>
84)         AllowOverride None<br/>
85)     &lt;/Directory&gt;<br/>

86) 

87) </VirtualHost>
88) </pre>

89)     </tt>

90)     <p>

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

93)     </p>

94)     <tt>

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

99) 

100)     root /var/www/mirrors/torproject.org;
101)     index index.html.en;

102) 

103)     location  / {
104)         autoindex on;

105)     }

106) }
107) </pre>

108)     </tt>

109)     <p>

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

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

112)     </p>

113)     <tt>

114) <pre>
115) text/html                             en html htm shtml;
116) </pre>

117)     </tt>
118)     <br/><br>

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

123)     <br/>

124)     <a id="mirrorops"></a>

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

126)     <p>

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

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

132) 

133)     <p>
134)     In order to add your mirror, please send a
135)     single, comma delimited line of text based on <a

136)     href="https://gitweb.torproject.org/project/web/webwml.git/plain/include/tor-mirrors.csv">this

137)     file</a> to the mirrors list. Your mirror will then be added manually
138)     if it passes availability testing and your provided information is

139)     confirmed. Some general pointers on mirrors are:

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

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

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

145)     </ol>

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