Skip to content

Commit

Permalink
Rename the project ftpgrab ! (Issue #28)
Browse files Browse the repository at this point in the history
  • Loading branch information
crazy-max committed Mar 15, 2017
1 parent 9a611e4 commit 531b761
Show file tree
Hide file tree
Showing 6 changed files with 200 additions and 185 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
@@ -1 +1 @@
Please read this page https://ftp-sync.github.io/doc/reporting-issue before reporting an issue.
Please read this page https://ftpgrab.github.io/doc/reporting-issue before reporting an issue.
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2013-2016 Cr@zy
Copyright (c) 2013-2017 Cr@zy

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
36 changes: 18 additions & 18 deletions README.md
@@ -1,53 +1,53 @@
<p align="center"><a href="https://ftp-sync.github.io" target="_blank"><img width="100" src="https://ftp-sync.github.io/img/logo.png"></a></p>
<p align="center"><a href="https://ftpgrab.github.io" target="_blank"><img width="100" src="https://ftpgrab.github.io/img/logo.png"></a></p>

<p align="center">
<a href="https://github.com/ftp-sync/ftp-sync/releases/latest"><img src="https://img.shields.io/github/release/ftp-sync/ftp-sync.svg?style=flat-square" alt="GitHub release"></a>
<a href="https://github.com/ftpgrab/ftpgrab/releases/latest"><img src="https://img.shields.io/github/release/ftpgrab/ftpgrab.svg?style=flat-square" alt="GitHub release"></a>
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=7NFD44VBNE3VL"><img src="https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square" alt="Donate Paypal"></a>
<a href="https://flattr.com/submit/auto?user_id=crazymax&url=https://ftp-sync.github.io"><img src="https://img.shields.io/badge/flattr-this-green.svg?style=flat-square" alt="Flattr this!"></a>
<a href="https://flattr.com/submit/auto?user_id=crazymax&url=https://ftpgrab.github.io"><img src="https://img.shields.io/badge/flattr-this-green.svg?style=flat-square" alt="Flattr this!"></a>
</p>

## About

**FTP Sync** is a shell script to synchronize files between a remote FTP server and your local server / computer.<br />
**FTPGrab** (formerly *FTP Sync*) is a shell script to grab your files from a remote FTP server to your NAS / server / computer.<br />

A file containing the hash of the name of each downloaded file will prevent re-download a file even if it is not present in the destination directory.<br />

You can also apply a filter to search for files with a regular expression.<br />

Because this script only need `wget`, it is ideal for those with a seedbox or a shared seedbox to synchronize with a NAS (Synology Qnap D-Link) or a local computer...<br />

With the sqlite3 [HASH_STORAGE](https://ftp-sync.github.io/doc/configuration/#hash_storage), the process performance will be improved!.
With the sqlite3 [HASH_STORAGE](https://ftpgrab.github.io/doc/configuration/#hash_storage), the process performance will be improved!.

Before reporting an issue, please read the [Troubleshooting page](https://ftp-sync.github.io/doc/troubleshooting).<br />
Before reporting an issue, please read the [Troubleshooting page](https://ftpgrab.github.io/doc/troubleshooting).<br />
Do not forget to star :star2: the project if you like it :heart_eyes:

## Documentation

* [Get started](https://ftp-sync.github.io/doc/get-started)
* [Configuration](https://ftp-sync.github.io/doc/configuration)
* [Troubleshooting](https://ftp-sync.github.io/doc/troubleshooting)
* [Changelog](https://ftp-sync.github.io/doc/changelog)
* [Upgrade notes](https://ftp-sync.github.io/doc/upgrade-notes)
* [Reporting an issue](https://ftp-sync.github.io/doc/reporting-issue)
* [Get started](https://ftpgrab.github.io/doc/get-started)
* [Configuration](https://ftpgrab.github.io/doc/configuration)
* [Troubleshooting](https://ftpgrab.github.io/doc/troubleshooting)
* [Changelog](https://ftpgrab.github.io/doc/changelog)
* [Upgrade notes](https://ftpgrab.github.io/doc/upgrade-notes)
* [Reporting an issue](https://ftpgrab.github.io/doc/reporting-issue)

## Logs

Each time the script is executed, a log file is created prefiexd by the config used.<br />
Here is an example :

```console
FTP Sync v4.0 (seedbox - 2017/03/14 01:41:49)
FTPGrab v4.1 (seedbox - 2017/03/15 01:41:49)
--------------
Config: seedbox
Script PID: 19383
Log file: /var/log/ftp-sync/seedbox-20170314014149.log
Log file: /var/log/ftpgrab/seedbox-20170315014149.log
FTP sources count: 1
FTP secure: 1
Download method: curl
Resume downloads: 1
Hash type: md5
Hash storage: sqlite3
Hash file: /opt/ftp-sync/hash/seedbox.db
Hash file: /opt/ftpgrab/hash/seedbox.db
--------------
Source: ftp://198.51.100.0:21/complete/
Destination: /tmp/seedbox/
Expand Down Expand Up @@ -82,10 +82,10 @@ Any funds donated will be used to help further development on this project! :gif

<p>
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=7NFD44VBNE3VL">
<img src="https://ftp-sync.github.io/img/paypal.png" alt="Donate Paypal">
<img src="https://ftpgrab.github.io/img/paypal.png" alt="Donate Paypal">
</a>
<a href="https://flattr.com/submit/auto?user_id=crazymax&url=https://ftp-sync.github.io">
<img src="https://ftp-sync.github.io/img/flattr.png" alt="Flattr this!">
<a href="https://flattr.com/submit/auto?user_id=crazymax&url=https://ftpgrab.github.io">
<img src="https://ftpgrab.github.io/img/flattr.png" alt="Flattr this!">
</a>
</p>

Expand Down
28 changes: 26 additions & 2 deletions UPGRADE.md
@@ -1,8 +1,32 @@
## 3.x > 4.x
## 4.0 > 4.1

To upgrade from 3.x to 4.x you have to move some files and rename the config and hash file to a custom name like `seedbox.conf` in the below example.
Since the project has been renamed `ftpgrab`, some changes has to be made.

```console
// Rename files and folders
$ mv /opt/ftp-sync/ /opt/ftpgrab
$ mv /var/log/ftp-sync/ /var/log/ftpgrab
$ mv /var/run/ftp-sync/ /var/run/ftpgrab
$ mv /opt/ftpgrab/ftp-sync.conf /opt/ftpgrab/ftpgrab.conf
$ mv /etc/init.d/ftp-sync /etc/init.d/ftpgrab

// Download the latest script and dist config
$ wget https://raw.github.com/ftpgrab/ftpgrab/master/ftpgrab.sh -O /etc/init.d/ftpgrab --no-check-certificate
$ chmod +x /etc/init.d/ftpgrab
$ wget https://raw.github.com/ftpgrab/ftpgrab/master/ftpgrab.conf -O /opt/ftpgrab/ftpgrab.conf --no-check-certificate
```

If you have a cron, do not forget to change the script's name :

```
0 4 * * * cd /etc/init.d/ && ./ftpgrab seedbox.conf >/dev/null 2>&1
```

## 3.x > 4.0

To upgrade from 3.x to 4.x you have to move some files and rename the config and hash file to a custom name like `seedbox.conf` in the below example.

```console
// Move to /opt
$ mv /etc/ftp-sync /opt
$ cd /opt/ftp-sync/
Expand Down
4 changes: 2 additions & 2 deletions ftp-sync.conf → ftpgrab.conf 100755 → 100644
@@ -1,5 +1,5 @@
# This file is an integral part of FTP Sync.
# More info : https://ftp-sync.github.io
# This file is an integral part of FTPGrab.
# More info : https://ftpgrab.github.io

# General
DIR_DEST="/tmp/seedbox"
Expand Down

0 comments on commit 531b761

Please sign in to comment.