ssfs view README @ rev 10
We can detect a Public in Sync if user wants public files
| author | Christophe Lincoln <pankso@slitaz.org> |
|---|---|
| date | Sat Jun 11 18:08:22 2011 +0200 (2011-06-11) |
| parents | c6866a2aa68f |
| children | 4384bbec9d9a |
line source
1 SliTaz Secure File Storage
2 ===============================================================================
5 Ssfs is a personnal and secure, fast and light online file storage powered by
6 SSH, Rsync, Lsyncd and SHell script. It monitor a local folder and automaticaly
7 synchronize the remote server, when files are tranfert they are compressed and
8 encrypted with SSH. Connection to the remote host is automate with a RSA key,
9 and for each client the key must be sent to the server via SSH password login.
11 Using ssfs let you have a live synchronized and secure folder between many
12 computers with an online copy on a secure Linux server. But even without
13 connections you have access to your files. Connection to the remote server
14 can also be done using the command line and 'ssh' from any clients such as
15 BSD, Android, OSX or Windows via Putty.
17 Ssfs is very easy to install, setup and configure to make you own secure online
18 file storage. It provide a cmdline tool for the client and the server with a
19 build in help, this README is also a howto in itself.
21 On the server side admin can choose by creating standard accounts or chrooted
22 accounts wich enforce server security by restricting available commands in a
23 minimal chroot environment. User $HOME should be set to 0700 so users can't see
24 other users files.
27 Installation
28 ------------
29 To work you need an SSH client, 'rsync' and 'lsyncd' installed, on SliTaz you
30 can simply install ssfs and it dependencies or to 'make install' from the
31 source directory (see the Development section).
34 Client help and setup
35 ---------------------
36 The cmdline interface ssfs let you setup a client and start the daemon and live
37 synchronization with your system session via the Window Manager autostart
38 script or your personnal ~/.profile file. To get a list of commands with
39 a short description:
41 $ ssfs help
43 To setup a client by creating a Lua configuration file and sending the RSA key
44 to the server, you can use the command 'setup'. Setup needs a login name and
45 server name or IP adress and it will also create a secure RSA if no existing:
47 $ ssfs setup --login=user --host=server
50 GUI & Web interface
51 -------------------
52 Actually they is a smal GTK/Yad but no web interface. The tool ssfs-box will
53 dipply info if a configuration file exist or start the setup box.
56 Get configs on boot
57 -------------------
58 Ssfs can be used in a boot scripts to connect to remote host and retrive data
59 before user session is started. It can be usful to provide persitent data for
60 Live systems and web boot.
63 Server setup
64 ------------
65 On the server you must have a SSH server running and an user account with a
66 ~/Sync folder. If you want to create a chroot for users you can use use the
67 tool ssfs-server. Here is a short example to create a chroot and create a user
68 login 'tux-sync' with a protected $HOME in the chroot, the root directory can
69 be specified on the command line or changed in the configuration file:
71 # ssfs-server gen-chroot
72 # ssfs-server adduser --login=tux-sync --id=2000 --pass=tuX0cc
74 Users can be listed or completely deleted including all file in home. More
75 information with: ssfs-server usage
78 Server users config
79 -------------------
80 When adding a user with 'ssfs-server adduser', the user is added to the host
81 /etc/passwd and a custom user config file is created in SSFS_USERS with the
82 login name.
85 Development and Bugs
86 --------------------
87 If you want to install latest code to test and help in developement you can
88 clone ssfs Mercurial repository. As usual cose folloy SliTaz light philosofy
89 with speed and security in mind:
91 $ hg clone http://hg.slitaz.org/ssfs
93 Install with 'make install' (DESTDIR is supported for packaging), update POT
94 file if any new string have been added with 'make pot' and merger PO files with
95 the command 'make msgmerge'. Any ideas are welcome and can be discuss, if you
96 are searching for something to do you can have a look to the TODO file :-)
98 Bugs can be reported on SliTaz mailing list, forum or scn since devel forum is
99 synced, all sites are liked from the main website at: http://www.slitaz.org/
102 ===============================================================================