aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDaniel Lange <DLange@git.local>2016-02-23 10:47:52 +0100
committerDaniel Lange <DLange@git.local>2016-02-23 10:47:52 +0100
commit3fa4a5e2ab7fd6e7810b5ec07eac8bef46298e16 (patch)
tree5593cc13aef65095bb8d030eef8a9a5dcf964349 /README.md
parent507c7bbc4f74e8ca972d1b248e7469bc4315046d (diff)
downloadbitpocket-3fa4a5e2ab7fd6e7810b5ec07eac8bef46298e16.tar.gz
bitpocket-3fa4a5e2ab7fd6e7810b5ec07eac8bef46298e16.tar.bz2
bitpocket-3fa4a5e2ab7fd6e7810b5ec07eac8bef46298e16.zip
Update to Faster IT versions and update README and LICENSE files
Diffstat (limited to 'README.md')
-rw-r--r--README.md65
1 files changed, 46 insertions, 19 deletions
diff --git a/README.md b/README.md
index 052bc85..6da9e9e 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,43 @@
# bitpocket
-[![Build Status](https://secure.travis-ci.org/sickill/bitpocket.png?branch=master)](http://travis-ci.org/sickill/bitpocket)
+Originally cloned from git://github.com/sickill/bitpocket.git
## About
+This is a fork of @sickill/bitpocket we used internally since 2014.
+While there are quicks (e.g. bitpocket does not backup files it deletes from the server)
+we have found this tool to be very useful for controlled multi-device syncing for
+tech-savy users.
+
+We use it cross-platform for Linux, Windows/cygwin (bitpocket) and Mac OSX
+with homebrew (bitpocket_mac).
+
+If you are new to bitpocket:
+
**bitpocket** is a small but smart script that does 2-way directory
synchronization. It uses _rsync_ to do efficient data transfer and tracks local
file creation/removal to avoid known rsync problem when doing 2-way syncing
with deletion.
bitpocket can use any server which you have ssh access to for its central
-storage. If you have gigabytes of free disk space on your hosting server you
-can finally make use of it.
+storage.
## Installation
-Clone repository and symlink `bitpocket` bin to sth in your `$PATH`:
+Clone repository and symlink `bitpocket` (or the `bitpocket_mac`) bin to somewhere within your `$PATH`:
- $ git clone git://github.com/sickill/bitpocket.git
- $ ln -s `pwd`/bitpocket/bin/bitpocket ~/bin/bitpocket
+ $ git clone git://github.com/fasterit/bitpocket.git
+ $ ln -s `pwd`/bitpocket/bitpocket ~/bin/bitpocket
Or download script and place it in a directory in your `$PATH`:
- $ curl -sL https://raw.github.com/sickill/bitpocket/master/bin/bitpocket > ~/bin/bitpocket
+ $ curl -sL https://raw.github.com/fasterit/bitpocket/master/bitpocket > ~/bin/bitpocket
$ chmod +x ~/bin/bitpocket
+For MacOSX you need _homebrew_ and have `coreutils` and `gnu-sed` installed ... eh ... "brewed".
+The BSD versions of coreutils and sed that MacOSX ships are just way too old to be useful.
### Setting up master
@@ -50,16 +61,18 @@ On each machine you want to synchronize initialize an empty directory as your bi
After installation, you use the `bitpocket` command for synchronization and other tasks.
Running `bitpocket help` will display the following message.
- usage: bitpocket [sync|help|pack|log|cron|list|init <REMOTE_HOST> <REMOTE_PATH>]
+ usage: bitpocket [sync | push | pull | pack | log | cron | list | help]
+ bitpocket init {<REMOTE_HOST> | ""} <REMOTE_PATH>
- Available commands:
- sync Run the sync process. If no command is specified, sync is run by default.
- init Initialize a new bitpocket folder. Requires remote host and path params.
- pack Pack any existing (automatic) backups into a git repository.
- cron Run sync optimized for cron, logging output to file instead of stdout.
- log Display the log generated by the cron command
- list List all files in the sync set (honoring include/exclude/filter config).
- help Show this message.
+ sync Run the sync process. If no command is specified, sync is run by default.
+ push Only push new files to the server.
+ pull Only pull new files from the server.
+ init Initialize a new bitpocket folder. Requires remote host and path params.
+ pack Pack any existing (automatic) backups into a git repository.
+ cron Run sync optimized for cron, logging output to file instead of stdout.
+ log Display the log generated by the cron command
+ list List all files in the sync set (honoring include/exclude/filter config).
+ help Show this message.
Note: All commands (apart from help), must be run in the root of a
new or existing bitpocket directory structure.
@@ -78,6 +91,17 @@ before adding new files to the slave directory. If there are files in the master
will be pulled into the slave. You may then move files into your slave directory and
they will be detected as added.
+To improve the safetely of daily operations the Faster IT version of bitpocket has
+patches added which allow to only `push` or `pull`.
+
+So
+
+ $ cd ~/BitPocket
+ $ bitpocket pull
+
+will only pull from the server and leave files there unclobbered.
+Similarly `bitpocket push` will sync new files to the server but not risk local files
+when you are in a hurry.
### Maintaining backups (bitpocket pack)
@@ -99,8 +123,10 @@ This requires an installation of _git_, but
allows all the space saving advantages of _git_ when making repeated changes
to the same files.
-There is a discussion about potential directions for versioning direction here:
-[github.com/sickill/bitpocket/issues/15](https://github.com/sickill/bitpocket/issues/15)
+There is a discussion about potential directions for versioning direction in the
+issue 15 of sickill's original bitpocket git:
+[github.com/sickill/bitpocket/issues/15](https://github.com/sickill/bitpocket/issues/15)
+(tl;dr version: The discussion wasn't conclusive.)
### Redirecting output to log file (bitpocket cron)
@@ -225,7 +251,8 @@ You can show tray icon during long sync with
SLOW_SYNC_STOP_CMD='kill `cat .bitpocket/traytor.pid`'
-## Author
+## Authors
* Marcin Kulik | @sickill | https://github.com/sickill | http://ku1ik.com/
* torfason | https://github.com/torfason
+* Faster IT GmbH | https://www.faster-it.com | https://git.faster-it.com

© 2014-2022 Faster IT GmbH | imprint | privacy policy