ssfs rev 30
README, TODO: tiny edits
author | Paul Issott <paul@slitaz.org> |
---|---|
date | Sun Jun 12 09:50:13 2011 +0100 (2011-06-12) |
parents | 8727a2a80b10 |
children | bb7a9ec53298 |
files | README TODO |
line diff
1.1 --- a/README Sun Jun 12 09:49:52 2011 +0200 1.2 +++ b/README Sun Jun 12 09:50:13 2011 +0100 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,40 +79,40 @@ 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 Get configs on boot 1.53 ------------------- 1.54 -Ssfs can be used in a boot scripts to connect to a remote host and retrieve data 1.55 +Ssfs can be used in a boot script to connect to a remote host and retrieve data 1.56 before a user session is started. It can be useful to provide persistent data for 1.57 Live systems and web boot. 1.58 1.59 1.60 Quota management 1.61 ---------------- 1.62 -Actually the quota storage is based on a shared idea, the vdisk have a size and 1.63 -all users share the space. For a pay service the vdisk can grow follwing the 1.64 +Actually the quota storage is based on a shared idea, the vdisk has a size and 1.65 +all users share the space. For a pay service the vdisk can grow following the 1.66 users donations or monthly subscription. 1.67 1.68 1.69 Server setup 1.70 ------------ 1.71 On the server you must have a SSH server running and an user account with a 1.72 -~/Sync folder in user home. You can have both, staandard accounts or chrooted 1.73 -accounts, for a hosted service it is recommended to use a chroot and Ssfs 1.74 +~/Sync folder in user home. You can have both, standard accounts or chrooted 1.75 +accounts, for a hosted service it is recommended to use a chroot and a Ssfs 1.76 virtual disk. The vdisk can be any size you want and have a minimal chroot 1.77 environment that is under 3Mb. 1.78 1.79 -If you want to create a vdisk and chroot automaticaly you can use use the tool 1.80 +If you want to create a vdisk and chroot automatically you can use use the tool 1.81 ssfs-server. Here is a short example to create a chroot and create a user 1.82 login 'tux-sync' with a protected $HOME in the chroot, the root directory can 1.83 be specified on the command line or changed in the configuration file. The 1.84 -vdisk creation size is set in Gb and can be changed in config file or from 1.85 +vdisk creation size is set in Gb and can be changed in the config file or from 1.86 the cmdline: 1.87 1.88 # ssfs-server gen-vdisk --size=2 1.89 @@ -127,11 +127,11 @@ 1.90 Ssfs virtual disk 1.91 ----------------- 1.92 A virtual Ssfs disk is a raw file created with dd and formated in ext3. It is 1.93 -mounted by default on /ssfs and contain a minimal chroot environemt with users 1.94 -home directory. We use a virtual disk to enforce securiry and use a separate 1.95 -media for Ssfs secure files, it also protect the host and limit storage size. 1.96 -The tool ssfs-server handle vdisk creation but you can also create one manually 1.97 -or use a separate HD if the server have more than one disk. To create 2Gb 1.98 +mounted by default on /ssfs and contains a minimal chroot environment with a user's 1.99 +home directory. We use a virtual disk to enforce security and use a separate 1.100 +media for Ssfs secure files, it also protects the host and limits storage size. 1.101 +The tool ssfs-server handles vdisk creation but you can also create one manually 1.102 +or use a separate HD if the server has more than one disk. To create a 2Gb 1.103 vdisk and format it to ext3: 1.104 1.105 # dd if=/dev/zero of=/home/ssfs.disk bs=1G count=2 1.106 @@ -160,9 +160,9 @@ 1.107 1.108 Server web interface 1.109 -------------------- 1.110 -Ssfs package provide a small CGI SHell web interface to the server. The goal 1.111 -to provide service status an information. It use the server configuration to 1.112 -know Ssfs virtual disk path and display statistics about the filesystem. 1.113 +Ssfs package provides a small CGI SHell web interface to the server. The goal is 1.114 +to provide a service status and information. It uses the server configuration to 1.115 +know the Ssfs virtual disk path and display statistics about the filesystem. 1.116 1.117 1.118 Development and Bugs 1.119 @@ -177,9 +177,9 @@ 1.120 are searching for something to do you can have a look to the TODO file :-) 1.121 1.122 Bugs can be reported on the SliTaz mailing list, forum or scn since the devel 1.123 -forum is synced. All sites are liked from: http://www.slitaz.org/ 1.124 +forum is synced. All sites are linked from: http://www.slitaz.org/ 1.125 1.126 -To share ideas and get involved into Ssfs project you can join the Ssfs group 1.127 +To share ideas and get involved in the Ssfs project you can join the Ssfs group 1.128 on the SliTaz Community Network website : http://scn.slitaz.org/groups/ssfs/ 1.129 1.130
2.1 --- a/TODO Sun Jun 12 09:49:52 2011 +0200 2.2 +++ b/TODO Sun Jun 12 09:50:13 2011 +0100 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