| rev |
line source |
|
pankso@1
|
1 SliTaz Secure File Storage
|
|
pankso@1
|
2 ===============================================================================
|
|
pankso@1
|
3
|
|
pankso@1
|
4
|
|
paul@11
|
5 Ssfs is personal, secure, fast and light online file storage powered by
|
|
paul@11
|
6 SSH, Rsync, Lsyncd and SHell script. It monitors a local folder and automatically
|
|
paul@11
|
7 synchronizes the remote server. When files are transferred they are compressed and
|
|
paul@11
|
8 encrypted with SSH. Connections to the remote host are automated with a RSA key,
|
|
paul@11
|
9 and for each client the key must be sent to the server via a SSH password login.
|
|
pankso@1
|
10
|
|
paul@11
|
11 Using ssfs lets you have a live synchronized and secure folder between many
|
|
paul@11
|
12 computers with an online copy on a secure Linux server. But even without any
|
|
paul@11
|
13 connections you have access to your files. Connections to the remote server
|
|
pankso@1
|
14 can also be done using the command line and 'ssh' from any clients such as
|
|
pankso@1
|
15 BSD, Android, OSX or Windows via Putty.
|
|
pankso@1
|
16
|
|
paul@11
|
17 Ssfs is very easy to install, setup and configure to make your own secure online
|
|
paul@11
|
18 file storage. It provides a cmdline tool for the client and the server with a
|
|
paul@11
|
19 built in help. This README is also a howto in itself.
|
|
pankso@1
|
20
|
|
pankso@1
|
21 On the server side admin can choose by creating standard accounts or chrooted
|
|
paul@11
|
22 accounts which enforce server security by restricting available commands in a
|
|
pankso@1
|
23 minimal chroot environment. User $HOME should be set to 0700 so users can't see
|
|
pankso@1
|
24 other users files.
|
|
pankso@1
|
25
|
|
pankso@1
|
26
|
|
pankso@1
|
27 Installation
|
|
pankso@1
|
28 ------------
|
|
paul@11
|
29 To work you need a SSH client, 'rsync' and 'lsyncd' installed. On SliTaz you
|
|
paul@11
|
30 can simply install ssfs and it's dependencies or 'make install' from the
|
|
pankso@8
|
31 source directory (see the Development section).
|
|
pankso@1
|
32
|
|
pankso@1
|
33
|
|
pankso@1
|
34 Client help and setup
|
|
pankso@1
|
35 ---------------------
|
|
paul@11
|
36 The cmdline interface ssfs lets you setup a client and start the daemon and
|
|
paul@11
|
37 synchronize live with your system session via the Window Manager autostart
|
|
paul@11
|
38 script or your personal ~/.profile file. To get a list of commands with
|
|
pankso@8
|
39 a short description:
|
|
pankso@1
|
40
|
|
pankso@1
|
41 $ ssfs help
|
|
pankso@1
|
42
|
|
pankso@1
|
43 To setup a client by creating a Lua configuration file and sending the RSA key
|
|
pankso@1
|
44 to the server, you can use the command 'setup'. Setup needs a login name and
|
|
paul@11
|
45 server name or IP address and it will also create a secure RSA if none exists:
|
|
pankso@1
|
46
|
|
pankso@1
|
47 $ ssfs setup --login=user --host=server
|
|
pankso@1
|
48
|
|
pankso@1
|
49
|
|
pankso@1
|
50 GUI & Web interface
|
|
pankso@1
|
51 -------------------
|
|
paul@11
|
52 Actually there is a small GTK/Yad but no web interface. The tool ssfs-box will
|
|
paul@11
|
53 display info if a configuration file exists or start the setup box.
|
|
pankso@1
|
54
|
|
pankso@1
|
55
|
|
pankso@1
|
56 Get configs on boot
|
|
pankso@1
|
57 -------------------
|
|
paul@11
|
58 Ssfs can be used in a boot scripts to connect to a remote host and retrieve data
|
|
paul@11
|
59 before a user session is started. It can be useful to provide persistent data for
|
|
pankso@1
|
60 Live systems and web boot.
|
|
pankso@1
|
61
|
|
pankso@1
|
62
|
|
pankso@1
|
63 Server setup
|
|
pankso@1
|
64 ------------
|
|
pankso@1
|
65 On the server you must have a SSH server running and an user account with a
|
|
paul@11
|
66 ~/Sync folder. If you want to create a chroot for users you can use the
|
|
pankso@1
|
67 tool ssfs-server. Here is a short example to create a chroot and create a user
|
|
paul@11
|
68 login 'tux-sync' with a protected $HOME in the chroot. The root directory can
|
|
pankso@1
|
69 be specified on the command line or changed in the configuration file:
|
|
pankso@1
|
70
|
|
pankso@1
|
71 # ssfs-server gen-chroot
|
|
pankso@1
|
72 # ssfs-server adduser --login=tux-sync --id=2000 --pass=tuX0cc
|
|
pankso@1
|
73
|
|
paul@11
|
74 Users can be listed or completely deleted including all files in home. More
|
|
paul@11
|
75 information can be found with: ssfs-server usage
|
|
pankso@1
|
76
|
|
pankso@1
|
77
|
|
pankso@1
|
78 Server users config
|
|
pankso@1
|
79 -------------------
|
|
pankso@1
|
80 When adding a user with 'ssfs-server adduser', the user is added to the host
|
|
pankso@1
|
81 /etc/passwd and a custom user config file is created in SSFS_USERS with the
|
|
pankso@10
|
82 login name.
|
|
pankso@1
|
83
|
|
pankso@1
|
84
|
|
pankso@1
|
85 Development and Bugs
|
|
pankso@1
|
86 --------------------
|
|
paul@11
|
87 If you want to install the latest code to test and help in development you can
|
|
paul@11
|
88 clone the ssfs Mercurial repository. As usual, closely follow the SliTaz light
|
|
paul@11
|
89 philosophy with speed and security in mind:
|
|
pankso@1
|
90
|
|
pankso@1
|
91 $ hg clone http://hg.slitaz.org/ssfs
|
|
pankso@1
|
92
|
|
paul@11
|
93 Install with 'make install' (DESTDIR is supported for packaging), update the POT
|
|
paul@11
|
94 file if any new strings have been added with 'make pot', and merger PO files with
|
|
paul@11
|
95 the command 'make msgmerge'. Any ideas are welcome and can be discussed. If you
|
|
pankso@1
|
96 are searching for something to do you can have a look to the TODO file :-)
|
|
pankso@1
|
97
|
|
paul@11
|
98 Bugs can be reported on the SliTaz mailing list, forum or scn since the devel forum
|
|
paul@11
|
99 is synced. All sites are liked from the main website at: http://www.slitaz.org/
|
|
pankso@1
|
100
|
|
pankso@1
|
101
|
|
pankso@1
|
102 ===============================================================================
|
|
pankso@1
|
103
|