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)     <pre>
29)     rsync -av --exclude 'dist' --delete rsync://rsync.torproject.org/website-mirror tor-mirror/

30)     rsync -av --delete rsync://rsync.torproject.org/dist-mirror tor-mirror/dist/

31)     </pre>

32)     </tt>

33) 

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

37) 

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

40) 

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

43) 

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

46) 

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

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

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

52) 

53)     </p>

54)     <br><br>

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

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

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

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

70)     <VirtualHost 10.10.10.10:80>

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

72)             ServerName  ServerNameHere<br/>

73) 

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

75) 

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

81) 

82)     </VirtualHost>
83)     </pre>
84)     </tt>

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

91)     	listen 10.10.10.10:80;

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

96) 

97) 	location  / {

98) 	  autoindex on;
99)       }

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

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

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

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

116)     <br/>

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

118)     <p>

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

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

124) 

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

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

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

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

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

137)     </ol>

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