Metadata-Version: 2.1
Name: mirror
Version: 0.8.1
Summary: Mirror for open source mirror site to sync files
Home-page: http://mirror.bjtu.edu.cn
Author: Shang Yuanchun, Bob Gao
Author-email: Shang Yuanchun <idealities@gmail.com>, Bob Gao <gaobo@bjtu.edu.cn>
License: GPLv3
Description: # Mirror
        
        [![Build Status]][Travis CI] [![Python version]][PyPI] [![Release version]][Release url] [![PyPi version]][PyPI] [![AUR version]][AUR]
        
        `Mirror` is an open source python application for mirror site (e.g. [mirror.bjtu.edu.cn](https://mirror.bjtu.edu.cn)) to sync files from upstreams (it uses [rsync](http://rsync.samba.org/) internally), it actually works like a [cron](http://en.wikipedia.org/wiki/Cron), but still has some differences. It has been served for mirror.bjtu.edu.cn with more than 40 rsync [tasks](https://mirror.bjtu.edu.cn).
        
        You are welcome to send comments, patches and any others to [github](https://github.com/ideal/mirror/issues) or to [@idealities](http://twitter.com/idealities).
        
        Homepage: https://mirror.bjtu.edu.cn
        
        Authors
        =======
        
        * Shang Yuanchun
        * Bob Gao
        
        For contributors and past developers see: 
            AUTHORS
        
        Installation Instructions
        =========================
        
        ## Install from PyPI
        
        You can install `mirror` by running pip:
        
        ```bash
        $ sudo pip install mirror
        ```
        
        ## Install from source
        
        Or if you want to build and install from source:
        
        ```bash
        $ python setup.py build
        $ sudo python setup.py install
        ```
        
        ## Config and running
        
        After that, you are going to set up environment, you are encouraged to add a specific user to run `mirrord`, here we suppose the username is `mirror` and its home directory is `/home/mirror`.
        
        Make necessary directories:
        
        ```bash
        $ sudo chown mirror:mirror /var/log/mirrord /var/log/rsync
        $ sudo mkdir /etc/mirror
        $ sudo cp config/mirror.ini /etc/mirror/
        ```
        
        Now you can edit mirror.ini to fit your needs and run:
        ```bash
        $ mirrord
        ```
        and that's done. Also you can use `man mirrord` or `mirrord -h` to read the documents.
        
        If `mirrord` is running, you can run:
        ```bash
        $ mirrord -t
        ```
        to show the current task queue.
        
        <img src="http://ideal.github.io/mirror/images/tasks.png" alt="screenshot" />
        
        Contact/Support
        ===============
        
        Email: idealities@gmail.com
        
        Features
        ========
        
         * It's simple and easy to add a mirror
         * You can set a priorty for each mirror, from 1 to 10, 1 is highest
         * And scheduler will schedule a task depending on current conditions
         * You can also set a timeout for each mirror
         * Support for two stage syncing (for ubuntu, debian)
         * You can also use it as another cron...
        
        [Build Status]:    https://img.shields.io/travis/ideal/mirror/master.svg?logo=travis-ci
        [Travis CI]:       https://travis-ci.org/ideal/mirror
        [Release version]: https://img.shields.io/github/release/ideal/mirror.svg?logo=github
        [Release url]:     https://github.com/ideal/mirror/releases/latest
        [Python version]:  https://img.shields.io/pypi/pyversions/mirror.svg?logo=python
        [PyPI version]:    https://img.shields.io/pypi/v/mirror.svg?logo=python
        [PyPI]:            https://pypi.python.org/pypi/mirror
        [AUR version]:     https://img.shields.io/aur/version/mirror.svg?logo=arch-linux
        [AUR]:             https://aur.archlinux.org/packages/mirror
        
Keywords: open source mirror
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*
Description-Content-Type: text/markdown
