================================================================== LUnet Studio DataPlant 1.0 - Network-attached storage server ================================================================== 1. About 2. Installation 3. How it works 4. Help and support 5. History of changes 6. To-dos and bugs 7. License and copyrights ------------------------------ 1. About ------------------------------ DataPlant is collection of scripts to run and manage simple network-attached storage server based on Linux. It automatically installs all important packages and dependencies to provide these services: a) Network-attached storage accessible through Samba (known also as Microsoft Network sharing), FTP (File Transfer Protocol) and NFS (Network File System) in your local network. b) iSCSI Target server which allows to connect physical volumes or logical units and virtual disk images. c) Multimedia server for sharing music, movies and pictures through DLNA (Digital Living Network Alliance) protocol d) BitTorrent download and sharing center DataPlant also contains monitoring and logging daemon and shell control center for easy users and services management. ------------------------------ 2. Installation ------------------------------ DataPlant is prepared to run on freshly installed Linux operating system with configured network interfaces and connected to internet. It is recommended to use distribution which includes aptitude repositories like Debian or *Ubuntu distributions. Installation procedure: - - - - - - - - - - - - - - - a) Preparing system: - Mount empty filesystem or create empty directory which will be root for directory structure created for users data. Recommended path is "/mnt/vfs". - Make sure you have "apt-get" application installed. - Run "apt-get update" and "apt-get upgrade" commands as root which will tests sources availability and upgrades old packages. - When you want to install DataPlant to system with another repository manager than aptitude (for example yum), manually install these packages before installing DataPlant: dialog, samba, tgt, nfs-kernel-server, pure-ftpd, rygel, libpam-smbpass, libsamdb0, transmission-daemon, lm-sensors, hddtemp b) Installing software: - Unpack tarball - Go to unpacked directory "DataPlant_*" - Start "./install.sh" as root or "sudo ./install.sh" as sudo privileged user - Follow installer instructions c) After installation: It is recommended to restart yor system after installation to refresh all changed settings and loads all support services correctly. ------------------------------ 3. How it works ------------------------------ Filesystem structure: - - - - - - - - - - - - - - - All user files are stored in directory structure created in "data filesystem mountpoint" (asked by installer). Every user has its own "virtual filesystem" created on its home directory (/home/USER_LOGIN). There are empty directories created and real directories from data filesystem are mounted there. Users and folders sharing: - - - - - - - - - - - - - - - Every user is member of one primary group. Default group name for common users is created by installer. Secondary membership is also possible. It means that users can be members of theirs primary groups and also they can have access to shared folders from another groups. (for example you can create secondary membership to group "scan" where scanned documents are stored and every user with secondary membership to this group is able to show these documents) When user connects to NAS with SMB, FTP or NFS protocol, it will see directories: - USER_LOGIN Private directory to store user files accessible only for its. - USER_GROUP Shared directory for group members. Every group member can store files here to share it with another group members. - SECONDARY_GROUPS When user has secondary memberships, shared directories from secondary groups are also visible here. User can read files from these directories but he can not change files stored by primary group members. - Public Directory visible for everybody used to store files to share it with everybody. Subdirectory Downloads where are files downloaded by BitTorrent service is included here. - Multimedia Directory visible for everybody. Contains subdirectories to store music, movies and pictures provided by multimedia server for DLNA devices connected in local network. - Devices Directory visible for everybody. Connected external devices and media are mounted here (USB flashdiscs, CD/DVD media, etc...). Users and settings manager: - - - - - - - - - - - - - - - DataPlant contains Control Center application. It allows to manage users, groups, daemons and settings through simple dialogs and wizards. Log in as root to text terminal (on local console or through SSH) and Control Center starts automatically. When you accidentaly close it, use command "dataplant" to start it manually. When you can not use root credentials, run Control Center typing "sudo dataplant" command. ------------------------------ 4. Help and support ------------------------------ When you have questions or problems while using this software, please visit DataPlant homepage http://www.dataplant.lunet.sk/ or contact us: http://www.lunet.sk/kontakt.html ------------------------------ 5. History of changes ------------------------------ ver. 1.0.1409, rel. 27.09.2014 - - - - - - - - - - - - - - - - added generator to place readme file to user home directories - fixed bug 01/1409: Disable writing into user root directory ver. 1.0.1404, rel. 07.04.2014 - - - - - - - - - - - - - - - - fixed bug 04/1312: Fix bug - multiple group folder mount when adding user to secondary groups more than once. ver. 1.0.1312, rel. 22.12.2013 - - - - - - - - - - - - - - - - fixed bug 03/1311: Fix Pure-FTP bug - set correct perms mask to created and uploaded folders and files (777 and 666) ver. 1.0.1311, rel. 30.11.2013 - - - - - - - - - - - - - - - - first released version ------------------------------ 6. To-dos and bugs ------------------------------ [01/1311] Create web-baased control center. [02/1311] Extend download manager to download files from HTTP and FTP sources, not only from BitTorrent files. [01/1312] Allow to create superusers with all groups access and with customizable access to control center. [02/1312] Multi-language support - all text data stored in independent files /usr/share/dataplant/lng/LOCALE.lng [03/1312] Short on-line application manual on DataPlant homepage [05/1312] Add hardware monitoring tools to installer and create cron script which will save status to text file. [01/1401] Add collectd web interface to watch machine status. ------------------------------ 7. License and copyrights ------------------------------ DataPlant is open source package created by LUnet Studio. (c) 2013-2014 LUnet Studio, www.studio.LUnet.sk You can use it for free and you can customize everything for your special requirements. If you want to extend functionality or help us with making some of opened To-Dos, you can do it but please send changes to us. We will append these changes to our scripts and release it as new package for download from DataPlant homepage. Your name will be listed in credits on homepage and in this document. ==================================================================