[Openupload-svn-update] SF.net SVN: openupload:[82] trunk
Status: Beta
Brought to you by:
tsdogs
Menu
▾
▴
[Openupload-svn-update] SF.net SVN: openupload:[82] trunk
|
From: <ts...@us...> - 2008-10-24 14:44:13
|
Revision: 82
http://openupload.svn.sourceforge.net/openupload/?rev=82&view=rev
Author: tsdogs
Date: 2008-10-24 14:44:10 +0000 (Fri, 24 Oct 2008)
Log Message:
-----------
update the documentation.
Modified Paths:
--------------
trunk/CHANGELOG
trunk/INSTALL
trunk/README
Modified: trunk/CHANGELOG
===================================================================
--- trunk/CHANGELOG 2008-10-24 11:37:17 UTC (rev 81)
+++ trunk/CHANGELOG 2008-10-24 14:44:10 UTC (rev 82)
@@ -1,4 +1,4 @@
-Changelog before release (0.3?) (updated on 2008.10.18).
+Changelog before release (0.3?) (updated on 2008.10.24).
* General
- make sub www folders not accessible by default (some index.html files)
@@ -26,10 +26,13 @@
- LDAP authentication for Openldap and AD support
* Database
-- Review DB module functions
-- Updated txtdb with basic api
+ - Review DB module functions
+ - Updated txtdb with basic api
+ - Prepared SQL structures.
-* Acl for modules and plugins
+* Acl
+ - Modules
+ - Plugins
* Translations
- gettext module
@@ -37,7 +40,7 @@
- initial Italian translation
* Download
- - Changeed serve file method to not go over the memory php limit (output buffer)
+ - Changed serve file method to not go over the memory php limit (disable output buffer)
- Make download timeout configurable.
* Web site
Modified: trunk/INSTALL
===================================================================
--- trunk/INSTALL 2008-10-24 11:37:17 UTC (rev 81)
+++ trunk/INSTALL 2008-10-24 14:44:10 UTC (rev 82)
@@ -1,47 +1,209 @@
-This is a preliminary version of the notes
+ ------------------------------------------------------------------------------
+ OpenUpload installation notes
+ ------------------------------------------------------------------------------
+ Version: 0.3
+ Last updated: 2008-10-24
-Installation notes
+INTRODUCTION
-Multisite installation
-1. Download the source from http:/www.sf.net/projects/openupload
-2. Untar the file
- tar xzf <release>.tar.gz
-3. Copy all files to somewhere which is not accessible from the web (i.e. /usr/local/share/openupload)
-4. Copy the www/ files into the web server folder (i.e. /var/www/html) or create a web server alias to point to the www/ folder
-5. copy the www/config.inc.php.example and edit it to suit your installation
-6. Make sure the web server is able to write to the "data" directory
-7. Create the database
- see README for more information on mode and rights configuration
- mysql:
- - create the db and the user
- create database <database>;
- grant all privileges on <database>.* to '<user>'@'localhost' ideintified by '<password>';
- - import the database schema and default config options
- mysql <database> -u <user> -p < sql/mysql/1_schema.sql
- mysql <database> -u <user> -p < sql/mysql/2_base.sql
- - import the configuration mode (it is not required):
- mysql <database> -u <user> -p < sql/mysql/3_mode_<selected>.sql
- txt:
- - the txt is usable, but I would not suggest it unless it's a really low traffic site.
- - make sure the "rootdir" for the txtdb folder is writable by your apache user
- - copy the default files from sql/txt/*.txt to the "rootdir" folder
- - substitute the wanted mode configuration txt/modes/acl_<mode>.txt over the acl.txt
+ This document describes the basic steps to install Open Upload.
+ Be sure to also read README file.
-8. Point your browser to http://localhost/<wherever>
-9. Login with "admin" "admin"
-10. Go to Profile and change your admin e-mail and password
-11. Enjoy! :)
+INDEX
-N.B. If you want to change something in the templates I'd suggest to create a site template and put there the needed changed files,
- (templates/<yourtemplate> or www/templates/<yourtemplate>).
- The program will check for the exsistence of a file in the selected template folder, and if not found will go back to the default.
- This will avoid problems when updating the program to a new version.
+ * Requirements
+ * Quick Start
+ * Modes and Rights
+ * LDAP Authentication
+ * Multisite installation
+ * Templates / Logo change
-BIG FAT NOTE:
-The program will work even if you copy the whole folder into the web server root or a subdiretory.
-But:
-- You should make sure the files are not directly accessible via WEB
- More specifically:
- "data" directory where files are stored
- "txtdb" if a flat txt database is used
+ ------------------------------------------------------------------------------
+REQUIREMENTS
+
+ To be able to use this software you need:
+ - A running Web Server with PHP 5.x (version 4 has not been tested)
+ - Database (MySQL) (optional but raccomended)
+ - PHP and Web server must be configured to allow the file uploads
+ - PHP must be installed with the DATABASE backend you want to use,
+ and GD image extensions for captcha to work.
+ - Also the LDAP extension needs to be installed if you plan to use
+ LDAP/AD Authentcation.
+
+ ------------------------------------------------------------------------------
+
+QUICK START
+
+ * BIG FAT NOTE: This procedure is aimed to let you test the program functionality.
+ Once this program is right for you read the MULTISITE INSTALLATION to avoid
+ security issues.
+ You should make sure the files other than "www" are not directly accessible via WEB
+ More specifically this are the most important:
+ "data" directory where files are stored
+ "txtdb" if a flat txt database is used
+
+ * Download the source from http:/www.sf.net/projects/openupload
+ * Untar the file
+ tar xzf <release>.tar.gz
+ * Copy all files to somewhere which is accessible from the web (i.e. /var/www/html/openupload)
+ * Copy the www/config.inc.php.example and edit it to suit your installation
+ * Make sure the web server is able to write to the "data", "data/tmp" and "templates_c" directory
+ * Create the database
+ ( see MODES AND RIGHTS for more information on mode and rights configuration)
+ MYSQL:
+ - create the db and the user
+ create database <database>;
+ grant all privileges on <database>.* to '<user>'@'localhost' ideintified by '<password>';
+ - import the database schema and default config options
+ mysql <database> -u <user> -p < sql/mysql/1_schema.sql
+ mysql <database> -u <user> -p < sql/mysql/2_base.sql
+ - import the configuration mode (it is not required):
+ mysql <database> -u <user> -p < sql/mysql/3_mode_<selected>.sql
+ FLAT FILE (TXT):
+ - the txt is usable, but I would not suggest it unless it's a really low traffic site.
+ - make sure the "rootdir" for the txtdb folder is writable by your apache user
+ - copy the default files from sql/txt/*.txt to the "rootdir" folder
+ - substitute the wanted mode configuration txt/modes/acl_<mode>.txt over the acl.txt
+
+ * Point your browser to http://localhost/<wherever>
+ * Login with Username: admin Password: admin
+ * Go to Profile and change your admin e-mail and password
+ * Enjoy! :)
+
+ ------------------------------------------------------------------------------
+
+MODES AND RIGHTS
+
+ Application can be configured to achive different behavier depending on group rights.
+ It comes with a set of predefined rights so that it enables/disables features.
+ Mainly I think this are the most usefull modes one should require, but you are free to adapt
+ them after installation.
+
+ * Public
+ The site is completely public. No need for the user to login or register. It can upload and
+ download as it wishes. Still plugin limitations may apply.
+
+ * Service
+ The site is public for not registered users, but registered ones get more functionality (i.e.
+ less limitations, they can password protect the file, can send e-mails, etc).
+
+ * Restricted
+ The users to be able to upload need to register/login
+ The download is still public.
+
+ * Private
+ The users must login to upload and they are not able to register (the Admin adds the users).
+ The download is still available.
+ I think this is the best solution for a company or user which wants internal users to upload
+ files, but i.e. customers to download them freely.
+ IMHO this is the best configuration in conjunction with LDAP/AD Authentication.
+
+ * Internal use (which I do not provide, but might be needed)
+ This is a mode which could be used for some people, but unless needed you will need to
+ configure the rights yourself.
+ Mainly upload and download need a user to login.
+
+ Basically the rights are checked with this priority:
+
+ group / module / action
+ group / module / *
+ group / * / *
+ * / module / action
+ * / module / *
+ * / * / *
+
+ where * stands for any value.
+
+ With the LDAP authentication backend a user can be part of multiple groups.
+ The check is done for every group the user is part of, and if none of it are matched
+ the result is to deny the operation. (See LDAP AUTHENTICATION)
+
+ NOTE: Be carfull with rights as you might block yourself out
+
+ Also the plugins can be enabled and disabled based on the group a user is registered.
+ Probabaly you'll need to adapt it to suit your needs.
+ Plugins must be enabled / disabled on a group basis (this might change in the future),
+ there is no * for the group.
+
+ ------------------------------------------------------------------------------
+
+LDAP AUTHENTICATION
+
+ LDAP support is maily a company feature, where you want your internal users to be able to upload files,
+ and Customers to be able to download (without the need to login).
+
+ Supported (tested) infrastructures:
+ - Openldap (I test it against a Samba3 + Openldap structure).
+ - Active Directory (against a windows 2003 domain)
+
+ LDAP configuration can be quite triky so you'll need to undersand what the configuration options are:
+ - host : this is easy, the host to ask login requests (your LDAP / AD server)
+ - type : in case of Active Directory put 'AD' as value
+ - user : this is the user used to do LDAP/AD queries. I'd suggest to create a readonly user.
+ - password : the "readonly" user password
+ - domain : only for Active Directory, specifies the AD domain (i.e. yourdomain.local), it's used
+ for user authentication. (like Us...@yo...)
+ - basedn : this is the LDAP base DN
+ - userdn : the base dn for user searches. For LDAP it is also used for user authentication values
+ (i.e. uid=User,ou=Users,dc=yourdomain,dc=local), it's the ou=Users,dc=yourdomain,dc=local
+ - userckass : the objectClass associated to the users (leave user for AD)
+ - uid : the field that corresponds to the user login (could be cn, i.e. cn=admin,ou=Users,... )
+ - userfields : the list of correspondences between LDAP/AD attributes and the user fields
+ place particular attention to the group_id match, as it needs to match the main gid for
+ group name search.
+ - groupdn : Group base search path. Where groups are stored (could be the same as basedn)
+ - groupclass : The objectClass of a group (leave group for AD)
+ - gid : this is the value to be matched between the group_id in the user fields and the group)
+ - groupfields: this is a list of correspondence between LDAP/AD group attributes and the group fields
+ - sgid : Mainly needed for Openldap, the user might be part of other groups. this is the lookup
+ field for the login name to be a member of a group (not needed in AD)
+ - sgidfields : correpondence between ldap sub group attributes and group attributes (mainly it's the
+ same as groupfields) maybe I'll remove it, if I find out it's not needed.
+
+ Once you have configured this part you should make sure to be able to login as administrator and change rights.
+ It's probably a good idea to add a record with the Administrator group to be able to access anything.
+
+ I'd suggest to create a set of dedicated groups for the application (i.e. OpenUploadAdmin, OpenUploadUser),
+ in your LDAP/AD configuration, and manage rights for only this groups (obviously assign to them the
+ users you want to access the service)
+ Also I'm not really sure how it works if a user has more than 1 group with different rights (especially
+ on plugins)
+
+ If it's a simple company you can use the default "Domain Users" and "Domain Admins".
+
+ Please note that if LDAP is enabled you won't be able to manage users/groups from the Administration interface
+ (use the LDAP/AD for this)
+
+ I'd also suggest to assign your users an e-mail addess.
+
+ ------------------------------------------------------------------------------
+
+MULTISITE INSTALLATION
+
+ In the QUICK START you find out how to test the application.
+ For a better installation this are my suggestions:
+
+ Put the program somewhere which is not WEB accessible. (i.e. /usr/share/openupload)
+ You can then copy the www folder to the WEB server root (or subdirectory), or even better,
+ point the web server to the www folder if it's a single site configuration.
+
+ Make sure the "data", "data/tmp" and "templates_c" folders are writable by the web user.
+
+ Change the config.inc.php accordingly to your installation.
+
+ If you want a multisite be sure to have a different config.inc.php per site (and db or db prefix).
+ Create a template folder for every site (or maybe just 1 if you plan on changing only the logo).
+
+ ------------------------------------------------------------------------------
+
+TEMPLATES / LOGO CHANGES (Notes)
+
+ If you want to change something in the templates I'd suggest to create a site template and put
+ there the needed changed files,
+ (templates/<yourtemplate> or www/templates/<yourtemplate>).
+ The program will check for the exsistence of a file in the selected template folder, and if not
+ found will go back to the default.
+ This will avoid problems when updating the program to a new version.
+
+
Modified: trunk/README
===================================================================
--- trunk/README 2008-10-24 11:37:17 UTC (rev 81)
+++ trunk/README 2008-10-24 14:44:10 UTC (rev 82)
@@ -4,6 +4,7 @@
VERSION: 0.3
+
AUTHORS:
OpenUpload (http://openupload.sf.net/)
Copyright: 2008 Alessandro Briosi <ts...@br...>
@@ -27,10 +28,42 @@
It aims to be customizable/extendible.
It can be used inside enterprises for sharing files fast with customers.
+
INSTALLATION:
-
+
See INSTALL file for details.
+
+REPORTING BUGS / FEATURE REQUESTS / JOIN DEVELOPMENT:
+
+ There is a mailing list which can be used to report bugs and feature requests.
+ (see web site for detail)
+ I'd really apreciate any feedback.
+ As the project is in it's early stages the use of Track might be too much.
+ Maybe in the future...
+ Ho, and would really love to have somebody else work on the project.
+
+
+TRANSLATIONS:
+
+ Right now the program is only translated to Italian (sorry I only know Italian and Engligh)
+ Translating isn't that hard (at least the default template)
+ I have implemented 2 tranlsation modules, but I probably plan to have a tool which converts from
+ one to the other.
+ Right now you can choose to translate with a php array, or use gettext tools (like poedit), to
+ translate the app to your language.
+ It's divided in 2 parts. 1 is for the application, and 1 is for the template.
+ They are located in locale/* for the application and templates/default/locale for the 2nd.
+ Once your translation is ready please send it to me or the ML.
+
+
+RESTRICTIONS:
+
+ This program is released under the GPL license so be sure to follow it's restrictions.
+ You are encoraged to keep the link and copyright notice, but not oblied to.
+ So yes, you can remove the copyright notice. Don't replace it with yours though. :-)
+
+
COPYRIGHT:
Copyright (c) 2008 Alessandro Briosi. All rights reserved.
This software is released under the GNU General Public License.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
