redsmaster 1.0.2

This file is part of redsmaster, which was developed as part of a
bachelor thesis at the Karlsruhe Institute of Technology, Germany and
is hereby released under the following license terms.

Copyright 2013 Tobias Pöppke

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.



#################################################
# Introduction
#################################################

Reds stands for Revision controlled document storage.
With reds you can store your documents encrypted in the cloud
and still have full control over them,
because the encryption key is not stored at the cloud service provider.
The encryption key is always in your hands, so be careful not to lose it.

But that's not all. The integrity and authenticity of the stored documents is
ensured by means of digital signatures which are enforced by redsmaster for
every head commit.

But there is also a built-in SSH server with user management and access control.
So you can share the documents with those you want by giving them the address
of the server running redsmaster.

They can just use a standard mercurial client to connect to the server at
standard port 2222. For example:
hg clone ssh://averagejoe@yourserver/your-repo

Redsmaster also supports public key login with SSH.



#################################################
# Requirements
#################################################

To run redsmaster you need to have installed:

- s3ql
- python 2.7
- python-pip
- python-dev

Then simply install redsmaster using pip:

pip install path/to/redsmaster-x.y.z.tar.gz

I recommend to use a virtualenv for this.

The user running redsmaster must be in the fuse group.



#################################################
# Usage
#################################################

Here is a short usage example for Amazon S3.

Setup the filesystem in an existing S3 bucket:

redsmaster setup s3://your-bucket/

This will require your login information for S3.
After this is finished you can start redsmaster by typing:

redsmaster start s3://your-bucket/

Now you can access the repositories just like you would with a normal
mercurial server. Note, that right now there are 2 standard users:
guest and admin. They have no password so make sure to set them by typing:

redsmaster adduser admin --password

This will prompt for the new password for admin.

Now, you can start playing with redsmaster and when you're finished just type:

redsmaster stop