ssfs rev 72

Edit README
author Paul Issott <paul@slitaz.org>
date Mon Jun 13 19:52:42 2011 +0100 (2011-06-13)
parents 2143ab1630b5
children 3a2f682ce267
files README ssfs-env
line diff
     1.1 --- a/README	Mon Jun 13 20:42:07 2011 +0200
     1.2 +++ b/README	Mon Jun 13 19:52:42 2011 +0100
     1.3 @@ -14,9 +14,9 @@
     1.4  can also be done using the command line and 'ssh' from any clients such as
     1.5  BSD, Android, OSX or Windows via Putty.
     1.6  
     1.7 -Ssfs is very easy to install, setup and configure to make your own secure online
     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 +Ssfs is very easy to install, setup and configure to create your own secure 
    1.11 +online file storage. It provides a cmdline tool for the client and server with 
    1.12 +a built in help. This README is also a howto in itself.
    1.13  
    1.14  On the server side admin can choose by creating standard accounts or chrooted
    1.15  accounts which enforce server security by restricting available commands in a
    1.16 @@ -78,7 +78,7 @@
    1.17  
    1.18  $ ssfs setup --login=user --host=server
    1.19  
    1.20 -Once the client is setup you can synchronize from the server and start live
    1.21 +Once the client is setup you can synchronize from the server and start a live
    1.22  sync. You can also get quick access to your files and ssfs info with a nice
    1.23  startup icon in the desktop panel. To sync and start Ssfs notify:
    1.24  
    1.25 @@ -95,8 +95,8 @@
    1.26  the files. We may implement a HTTP Public dir which could handle xHTML pages, a
    1.27  wiki, etc.
    1.28  
    1.29 -The GTK gui provide a notification mode as explained previewsly and the main
    1.30 -window can be started from the standard menu and under the Network category.
    1.31 +The GTK gui provides a notification mode as explained previously and the main
    1.32 +window can be started from the standard menu within the Network category.
    1.33  
    1.34  
    1.35  Ssfs chroot SHell
    1.36 @@ -109,12 +109,12 @@
    1.37  the new user $HOME and changes the directory to it since chroot will drop us
    1.38  in / by default.
    1.39  
    1.40 -The SHell is part of Ssfs featurs and provide a secure access to user, SSH
    1.41 -login is automated with a RSA key, when chrooted users have access to all
    1.42 -commands in /bin and a helper tool called 'ssfs-env' in avalaible. Ssfs-env
    1.43 +The SHell is part of Ssfs features and provides a secure user access, SSH
    1.44 +login is automated with a RSA key where chrooted users have access to all
    1.45 +commands in /bin and a helper tool called 'ssfs-env' in available. Ssfs-env
    1.46  can display server info, list files and search for files or commands. Like
    1.47 -all other Ssfs tools user can get a small built-in help usage. To connect
    1.48 -to server and display ssfs-env help:
    1.49 +all other Ssfs tools users can get a small built-in help usage. To connect
    1.50 +to the server and display ssfs-env help:
    1.51  
    1.52  $ ssfs login
    1.53  user@ssfs:~$ ssfs-env help
    1.54 @@ -131,8 +131,8 @@
    1.55  ----------------
    1.56  Actually the quota storage is based on a shared idea, the vdisk has a size and
    1.57  all users share the space. For a pay service the vdisk can grow following the
    1.58 -users donations or monthly subscription. Also when sshs-server create a user
    1.59 -it assing a default quota that could be used for peer user quota.
    1.60 +users donations or monthly subscription. Also when sshs-server creates a user
    1.61 +it assigns a default quota that could be used as a per user quota.
    1.62  
    1.63  
    1.64  Server setup
    1.65 @@ -158,19 +158,19 @@
    1.66  
    1.67  # ssfs-server help
    1.68  
    1.69 -Vdisk chroot system can be extended if you want to provide more commands to
    1.70 -users. The minimal SliTaz chroot is easily maintainable and builded using
    1.71 -standard SliTaz packages. The package ssfs-busybox provide the minimal base
    1.72 -commands such as ls, cp, mc, cat, grep and have no dependencies since we just
    1.73 +The vdisk chroot system can be extended if you want to provide more commands 
    1.74 +to users. The minimal SliTaz chroot is easily maintainable and built using
    1.75 +standard SliTaz packages. The package ssfs-busybox provides the minimal base
    1.76 +commands such as ls, cp, mc, cat, grep and has no dependencies since we just
    1.77  need a few shared libs in /lib. Ssfs original chroot files are stored in the
    1.78 -directory /usr/share/ssfs/rootfs. The virtual disk contain a Linux jounalized
    1.79 +directory /usr/share/ssfs/rootfs. The virtual disk contains a Linux journalled
    1.80  ext3 filesystem that you can check and verify with:
    1.81  
    1.82  # ssfs-server check-vdisk
    1.83  
    1.84 -In a production environment dont forget to mount Ssfs vdisk on boot via fstab.
    1.85 -For maitainance purpose you can manually mount or unmount the disk and also
    1.86 -update it in a command, example:
    1.87 +In a production environment don't forget to mount Ssfs vdisk on boot via fstab.
    1.88 +For maintenance purposes you can manually mount or unmount the disk and also
    1.89 +update it with a command, example:
    1.90  
    1.91  # ssfs-server mount-vdisk
    1.92  # ssfs-server up-vdisk
    1.93 @@ -178,7 +178,7 @@
    1.94  
    1.95  Ssfs virtual disk
    1.96  -----------------
    1.97 -A virtual Ssfs disk is a raw file created with dd and formated in ext3. It is
    1.98 +A virtual Ssfs disk is a raw file created with dd and formatted in ext3. It is
    1.99  mounted by default on /ssfs and contains a minimal chroot environment with a user's
   1.100  home directory. We use a virtual disk to enforce security and use a separate
   1.101  media for Ssfs secure files, it also protects the host and limits storage size.
   1.102 @@ -196,7 +196,7 @@
   1.103  # mkdir /ssfs
   1.104  # mount -o loop -t ext3 /home/ssfs.disk /ssfs
   1.105  
   1.106 -To automaticaly mount the vdisk on boot you may want to add a ssfs system user
   1.107 +To automatically mount the vdisk on boot you may want to add a ssfs system user
   1.108  and a line into the file /etc/fstab:
   1.109  
   1.110  # adduser -S -g "Ssfs Server" -h /ssfs -s /bin/false ssfs
     2.1 --- a/ssfs-env	Mon Jun 13 20:42:07 2011 +0200
     2.2 +++ b/ssfs-env	Mon Jun 13 19:52:42 2011 +0100
     2.3 @@ -16,7 +16,7 @@
     2.4  $(echo -e "\033[1mCommands:\033[0m")
     2.5    help          Display this short help usage.
     2.6    info          Display account and system information.
     2.7 -  list          List all file in your Sync folder.
     2.8 +  list          List all files in your Sync folder.
     2.9    search        Search for a file or a system command.
    2.10  
    2.11  EOT