ssfs rev 32
merge
author | Christophe Lincoln <pankso@slitaz.org> |
---|---|
date | Sun Jun 12 11:08:53 2011 +0200 (2011-06-12) |
parents | d9e1240da61a 537bbb97d265 |
children | 95b88686a283 |
files | README |
line diff
1.1 --- a/README Sun Jun 12 11:08:25 2011 +0200 1.2 +++ b/README Sun Jun 12 11:08:53 2011 +0200 1.3 @@ -15,7 +15,7 @@ 1.4 BSD, Android, OSX or Windows via Putty. 1.5 1.6 Ssfs is very easy to install, setup and configure to make your own secure online 1.7 -file storage. It provides a cmdline tool for the client and the server with a 1.8 +file storage. It provides a cmdline tool for the client and server with a 1.9 built in help. This README is also a howto in itself. 1.10 1.11 On the server side admin can choose by creating standard accounts or chrooted 1.12 @@ -28,11 +28,11 @@ 1.13 -------- 1.14 1.15 * Online live sync with encrypted data 1.16 - * Drop files in a folder and they will be sync 1.17 - * Even without connection you have your data 1.18 + * Drop files in a folder and they will be synced 1.19 + * Even without any connection you have your data 1.20 * Fast and light using stable and mature GNU tools 1.21 * Easy to setup on the client and server side 1.22 - * Virtual disk for storage with minimal chroot 1.23 + * Virtual disk for storage with a minimal chroot 1.24 * Easy to backup, update and maintain vdisk 1.25 1.26 1.27 @@ -47,8 +47,8 @@ 1.28 # ssfs-server adduser --login=demo --id=2000 --pass=demo 1.29 * On the client side: ssfs-box setup or from the cmdline: 1.30 $ ssfs setup --login=demo --host="server name or ip" 1.31 - * On client you can start ssfs on user login via the WM 1.32 - autostart script and or the command $ ssfs sync 1.33 + * On the client you can start ssfs on user login via the WM 1.34 + autostart script and/or the command $ ssfs sync 1.35 * Get support and show your love for Ssfs on SCN group: 1.36 http://scn.slitaz.org/groups/ssfs/ 1.37 1.38 @@ -79,10 +79,10 @@ 1.39 GUI & Web interface 1.40 ------------------- 1.41 Actually there is a small GTK/Yad but no web interface. The tool ssfs-box will 1.42 -display info if a configuration file exists or start the setup box. Ther is no 1.43 +display info if a configuration file exists or start the setup box. There is no 1.44 plan for a users files web interface since security if more important, actually 1.45 -user home have 0700 mode as so standard web server running user www can't see 1.46 -the files. We may implemnt a HTTP Public dir wich coul handle xHTML pages, a 1.47 +a user's home has 0700 mode so a standard web server running user www can't see 1.48 +the files. We may implement a HTTP Public dir which could handle xHTML pages, a 1.49 wiki, etc. 1.50 1.51 1.52 @@ -99,31 +99,31 @@ 1.53 1.54 Get configs on boot 1.55 ------------------- 1.56 -Ssfs can be used in a boot scripts to connect to a remote host and retrieve data 1.57 +Ssfs can be used in a boot script to connect to a remote host and retrieve data 1.58 before a user session is started. It can be useful to provide persistent data for 1.59 Live systems and web boot. 1.60 1.61 1.62 Quota management 1.63 ---------------- 1.64 -Actually the quota storage is based on a shared idea, the vdisk have a size and 1.65 -all users share the space. For a pay service the vdisk can grow follwing the 1.66 +Actually the quota storage is based on a shared idea, the vdisk has a size and 1.67 +all users share the space. For a pay service the vdisk can grow following the 1.68 users donations or monthly subscription. 1.69 1.70 1.71 Server setup 1.72 ------------ 1.73 On the server you must have a SSH server running and an user account with a 1.74 -~/Sync folder in user home. You can have both, staandard accounts or chrooted 1.75 -accounts, for a hosted service it is recommended to use a chroot and Ssfs 1.76 +~/Sync folder in user home. You can have both, standard accounts or chrooted 1.77 +accounts, for a hosted service it is recommended to use a chroot and a Ssfs 1.78 virtual disk. The vdisk can be any size you want and have a minimal chroot 1.79 environment that is under 3Mb. 1.80 1.81 -If you want to create a vdisk and chroot automaticaly you can use use the tool 1.82 +If you want to create a vdisk and chroot automatically you can use use the tool 1.83 ssfs-server. Here is a short example to create a chroot and create a user 1.84 login 'tux-sync' with a protected $HOME in the chroot, the root directory can 1.85 be specified on the command line or changed in the configuration file. The 1.86 -vdisk creation size is set in Gb and can be changed in config file or from 1.87 +vdisk creation size is set in Gb and can be changed in the config file or from 1.88 the cmdline: 1.89 1.90 # ssfs-server gen-vdisk --size=2 1.91 @@ -138,11 +138,11 @@ 1.92 Ssfs virtual disk 1.93 ----------------- 1.94 A virtual Ssfs disk is a raw file created with dd and formated in ext3. It is 1.95 -mounted by default on /ssfs and contain a minimal chroot environemt with users 1.96 -home directory. We use a virtual disk to enforce securiry and use a separate 1.97 -media for Ssfs secure files, it also protect the host and limit storage size. 1.98 -The tool ssfs-server handle vdisk creation but you can also create one manually 1.99 -or use a separate HD if the server have more than one disk. To create 2Gb 1.100 +mounted by default on /ssfs and contains a minimal chroot environment with a user's 1.101 +home directory. We use a virtual disk to enforce security and use a separate 1.102 +media for Ssfs secure files, it also protects the host and limits storage size. 1.103 +The tool ssfs-server handles vdisk creation but you can also create one manually 1.104 +or use a separate HD if the server has more than one disk. To create a 2Gb 1.105 vdisk and format it to ext3: 1.106 1.107 # dd if=/dev/zero of=/home/ssfs.disk bs=1G count=2 1.108 @@ -171,9 +171,9 @@ 1.109 1.110 Server web interface 1.111 -------------------- 1.112 -Ssfs package provide a small CGI SHell web interface to the server. The goal 1.113 -to provide service status an information. It use the server configuration to 1.114 -know Ssfs virtual disk path and display statistics about the filesystem. 1.115 +Ssfs package provides a small CGI SHell web interface to the server. The goal is 1.116 +to provide a service status and information. It uses the server configuration to 1.117 +know the Ssfs virtual disk path and display statistics about the filesystem. 1.118 1.119 1.120 Development and Bugs 1.121 @@ -188,9 +188,9 @@ 1.122 are searching for something to do you can have a look to the TODO file :-) 1.123 1.124 Bugs can be reported on the SliTaz mailing list, forum or scn since the devel 1.125 -forum is synced. All sites are liked from: http://www.slitaz.org/ 1.126 +forum is synced. All sites are linked from: http://www.slitaz.org/ 1.127 1.128 -To share ideas and get involved into Ssfs project you can join the Ssfs group 1.129 +To share ideas and get involved in the Ssfs project you can join the Ssfs group 1.130 on the SliTaz Community Network website : http://scn.slitaz.org/groups/ssfs/ 1.131 1.132
2.1 --- a/TODO Sun Jun 12 11:08:25 2011 +0200 2.2 +++ b/TODO Sun Jun 12 11:08:53 2011 +0200 2.3 @@ -2,6 +2,6 @@ 2.4 2.5 * Check if we can use only Dropbear as SSH client and server 2.6 * A Web interface in CGI (SHell or Python) or PHP 2.7 - * Handle user quota, use vdisk peer user ? 2.8 + * Handle user quota, use vdisk per user ? 2.9 * A logo :-) 2.10