SliTaz Repositories

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Sat Jun 11 08:39:58 2011 +0200
     1.3 @@ -0,0 +1,104 @@
     1.4 +SliTaz Secure File Storage
     1.5 +===============================================================================
     1.6 +
     1.7 +
     1.8 +Ssfs is a personnal and secure, fast and light online file storage powered by
     1.9 +SSH, Rsync, Lsyncd and SHell script. It monitor a local folder and automaticaly
    1.10 +synchronize the remote server, when files are tranfert they are compressed and
    1.11 +encrypted with SSH. Connection to the remote host is automate with a RSA key,
    1.12 +and for each client the key must be sent to the server via SSH password login.
    1.13 +
    1.14 +Using ssfs let you have a live synchronized and secure folder between many
    1.15 +computers with an online copy on a secure Linux server. But even without
    1.16 +connections you have access to your files. Connection to the remote server
    1.17 +can also be done using the command line and 'ssh' from any clients such as
    1.18 +BSD, Android, OSX or Windows via Putty.
    1.19 +
    1.20 +Ssfs is very easy to install, setup and configure to make you own secure online
    1.21 +file storage. It provide a cmdline tool for the client and the server with a
    1.22 +build in help, this README is also a howto in itself.
    1.23 +
    1.24 +On the server side admin can choose by creating standard accounts or chrooted
    1.25 +accounts wich enforce server security by restricting available commands in a
    1.26 +minimal chroot environment. User $HOME should be set to 0700 so users can't see
    1.27 +other users files.
    1.28 +
    1.29 +
    1.30 +Installation
    1.31 +------------
    1.32 +To work you need an SSH client, 'rsync' and 'lsyncd' installed, on SliTaz you
    1.33 +can simply install ssfs and it dependencies or to 'make install' from the
    1.34 +source directory (see the Development section). To get a list of commands with
    1.35 +a sort description:
    1.36 +
    1.37 +
    1.38 +Client help and setup
    1.39 +---------------------
    1.40 +The cmdline interface ssfs let you setup a client and start the daemon and live
    1.41 +synchronization with your system session via the Window Manager autostart
    1.42 +script or your personnal ~/.profile file.
    1.43 +
    1.44 +$ ssfs help
    1.45 +
    1.46 +To setup a client by creating a Lua configuration file and sending the RSA key
    1.47 +to the server, you can use the command 'setup'. Setup needs a login name and
    1.48 +server name or IP adress and it will also create a secure RSA if no existing:
    1.49 +
    1.50 +$ ssfs setup --login=user --host=server
    1.51 +
    1.52 +
    1.53 +GUI & Web interface
    1.54 +-------------------
    1.55 +Actually they is no frontend or web interface, but it should be just a matter
    1.56 +of free time!
    1.57 +
    1.58 +
    1.59 +Get configs on boot
    1.60 +-------------------
    1.61 +Ssfs can be used in a boot scripts to connect to remote host and retrive data
    1.62 +before user session is started. It can be usful to provide persitent data for
    1.63 +Live systems and web boot.
    1.64 +
    1.65 +
    1.66 +Server setup
    1.67 +------------
    1.68 +On the server you must have a SSH server running and an user account with a
    1.69 +~/Sync folder. If you want to create a chroot for users you can use use the
    1.70 +tool ssfs-server. Here is a short example to create a chroot and create a user
    1.71 +login 'tux-sync' with a protected $HOME in the chroot, the root directory can
    1.72 +be specified on the command line or changed in the configuration file:
    1.73 +
    1.74 +# ssfs-server gen-chroot
    1.75 +# ssfs-server adduser --login=tux-sync --id=2000 --pass=tuX0cc
    1.76 +
    1.77 +Users can be listed or completely deleted including all file in home. More
    1.78 +information with: ssfs-server usage
    1.79 +
    1.80 +
    1.81 +Server users config
    1.82 +-------------------
    1.83 +When adding a user with 'ssfs-server adduser', the user is added to the host
    1.84 +/etc/passwd and a custom user config file is created in SSFS_USERS with the
    1.85 +login name. Actually the config file have unused variables but here in futur
    1.86 +prevision: PUBLIC="HTTP Public directory"
    1.87 +
    1.88 +
    1.89 +Development and Bugs
    1.90 +--------------------
    1.91 +If you want to install latest code to test and help in developement you can
    1.92 +clone ssfs Mercurial repository. As usual cose folloy SliTaz light philosofy
    1.93 +with speed and security in mind:
    1.94 +
    1.95 + $ hg clone http://hg.slitaz.org/ssfs
    1.96 +
    1.97 +Install with 'make install' (DESTDIR is supported for packaging), update POT
    1.98 +file if any new string have been added with 'make pot' and merger PO files with
    1.99 +the command 'make msgmerge'. Any ideas are welcome and can be discuss, if you
   1.100 +are searching for something to do you can have a look to the TODO file :-)
   1.101 +
   1.102 +Bugs can be reported on SliTaz mailing list, forum or scn since devel forum is
   1.103 +synced, all sites are liked from the main website at: http://www.slitaz.org/
   1.104 +
   1.105 +
   1.106 +===============================================================================
   1.107 +