https://github.com/alebcay/tor-mirror-bootstrap
Quickly set up a mirror of the Tor website on OSX
https://github.com/alebcay/tor-mirror-bootstrap
Last synced: 5 months ago
JSON representation
Quickly set up a mirror of the Tor website on OSX
- Host: GitHub
- URL: https://github.com/alebcay/tor-mirror-bootstrap
- Owner: alebcay
- Created: 2014-04-04T18:14:22.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2014-04-04T19:43:44.000Z (over 12 years ago)
- Last Synced: 2024-12-31T05:29:36.423Z (over 1 year ago)
- Language: Shell
- Homepage:
- Size: 148 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
tor-mirror-bootstrap
====================
Quickly set up a mirror of the Tor website on OSX.
## Requirements
Read [Tor's official documentation on running a mirror](https://www.torproject.org/docs/running-a-mirror.html.en) to learn more about the technical requirements. The system requirements for running a mirror are as follows:
* Have at least 8 GB of disk space on location where you wish to host mirror
* `cron`, `launchd`, or other system task scheduler
* A web server - Apache, nginx, etc.
This bootstrap script currently only checks the first requirement - the other two are up to you to deal with. This script's job is to download and update the files within your mirror, synchronizing them to those provided by the Tor project via `rsync`.
## Installation
1. Get this repo:
```
git clone https://github.com/alebcay/tor-mirror-bootstrap
```
2. Run the setup script. **`cd` to the location where you want the mirror to be, your mirror will be at `$(pwd)/tor-mirror`:
```
./setup
```
This could take a while. Your computer is fetching about 4.4 GB of data from Tor's servers at this step.
3. The docroot of the mirror is at `$(pwd)/tor-mirror`. Place this in an Apache `VirtualHost` block or an nginx `server` block.
## Updating
Tor requires all servers to remain updated with it's source. There should be `update` in the same directory as `setup`. Run it to update your sources (and make sure to schedule it with `cron`, `launchd`, etc.). **`update` runs in the same directory it's launched in, so make sure the working directory is set correctly when executing with `cron` or `launchd`.**