gnh1201/seeddms-code
1
0
Fork 0
mirror of https://git.code.sf.net/p/seeddms/code synced 2025-05-22 09:31:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

updated for version 4.0.0

Browse Source
This commit is contained in:
Uwe Steinmann 2013-02-14 11:12:54 +01:00
parent 952468bb92
commit 97c9a4558c
1 changed files with 148 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

271
README.md
View File

@ -11,45 +11,73 @@ PDO.
IMPORTANT NOTE ABOUT TRANSLATIONS
=================================
as you can see SeedDMS provides a lot of languages but we are not professional
As you can see SeedDMS provides a lot of languages but we are not professional
translators and therefore rely on user contributions.
If your language is not present in the login panel:
- copy the language/English/ folder and rename it appropriately for your
language
- open the file languages/your_lang/lang.inc and translate it
- open the help file languages/your_lang/help.htm and translate it too
- open the file `languages/your_lang/lang.inc` and translate it
- open the help file `languages/your_lang/help.htm` and translate it too
If you see some wrong or not translated messages:
- open the file languages/your_lang/lang.inc
- open the file `languages/your_lang/lang.inc`
- search the wrong messages and translate them
if you have some "error getting text":
- search the string in the english file (languages/english/lang.inc)
- copy to your language file (languages/your_lang/lang.inc)
- search the string in the english file `languages/english/lang.inc`
- copy to your language file `languages/your_lang/lang.inc`
- translate it
If there is no help in your language:
- Copy the English help (english/help.htm) file to your language folder
- Copy the English help `english/help.htm` file to your language folder
- translate it
If you apply any changes to the language files please send them to the
SeedDMS developers (www.seeddms.com).
SeedDMS developers <info@seeddms.org>.
REQUIREMENTS
============
SeedDMS is a web-based application written in PHP. It uses the MySQL RDBMS
or sqlite3 to manage the documents that were uploaded into the application.
Make sure you have PHP 5.3 and MySQL 5 or higher installed. SeedDMS
will work with PHP running in CGI-mode as well as running as module under
apache. If you want to give your users the opportunity of uploading passport
photos you have to enable the gd-library (but the rest of SeedDMS will
work without gd, too).
Here is a detailed list of requirements:
1. A web server with at least php 5.3
2. A mysql database, unless you use sqlite
3. The php installation must have support for `pdo_mysql` or `pdo_sqlite`,
`php_gd2`, `php_mbstring`
4. Various command line programms to convert files into text for indexing
pdftotext, catdoc, xls2csv or scconvert, cat, id3 (optional, only needed
for fulltext search)
5. The Zend Framework (version 1) (optional, only needed for fulltext search)
6. The pear Log package
7. The pear HTTP_WebDAV_Server package (optional, only need for webdav)
BEFORE YOU START
================
SeedDMS has changed its installation process with version 3.0.0. This gives
you many more options in how to install SeedDMS. First of all, SeedDMS was
split into a core package (LetoDMS_Core-<version>.tar.gz) and the web
application itself (seeddms-<version>.tar.gz). The core is a pear package
split into a core package (`LetoDMS_Core-<version>.tar.gz`) and the web
application itself (`seeddms-<version>.tar.gz`). The core is a pear package
which could be installed as one. It is responsible for all the database
operations. The web application contains the gui not knowing anything about
operations. The web application contains the ui not knowing anything about
the database layout. Second, one SeedDMS installation can be used for
various customer instances by sharing a common source. Starting with
version 3.2.0 a full text search engine has been added. This requires
the zend framework and another pear package LetoDMS_Lucene-<version>.tar.gz
which can be downloaded from the SeedDMS web page. Finally, SeedDMS has
the zend framework and another pear package `LetoDMS_Lucene-<version>.tar.gz`
which can be downloaded from the SeedDMS web page. Version 4.0.0 show
preview images of documents which requires `LetoDMS_Preview-<version>.tar.gz`.
Finally, SeedDMS has
got a web based installation, which takes care of most of the installation
process.
@ -60,7 +88,7 @@ Before you proceed you have to decide how to install SeedDMS:
Both have its pros and cons, but
1. setting up a single instance is easier if you have no shell access to
the web server
2. the installation script is only tested on single instances
2. the installation script is only tested for single instances
Installation for multiple instances shares the same source by many
instances but requires to create links which is not in any case possible
@ -70,8 +98,8 @@ on your web server.
-------------------
A common source of problems in the past have been the additional software
packages needed by SeedDMS. Those are the PEAR packages Log and
HTTP_WebDAV_Server as well as Zend_Framework and ADOdb.
packages needed by SeedDMS. Those are the PEAR packages `Log` and
`HTTP_WebDAV_Server` as well as the `Zend_Framework`.
If you have full access to the server running a Linux distribution it is
recommended to install those with your package manager if they are provided
by your Linux distribution. If you cannot install it this way then choose
@ -80,33 +108,38 @@ software into it and extend the php include path with your newly created
directory. Extending the php include can be either done by modifying
php.ini or adding a line like
php_value include_path '/home/mypath:.:/usr/share/php'
> php_value include_path '/home/mypath:.:/usr/share/php'
to your apache configuration. Do not forget to add the standard include_path.
Another way to make SeedDMS find all the additional software relies on the
ADOdb path in the configuration. The ADOdb path also extends the php
include path. This is done very early during the page creation. Consequently
all software installed below this path is found as well.
to your apache configuration or setting the `extraPath` configuration
variable of SeedDMS.
For both the LetoDMS_Core and LetoDMS_Lucene package the path can be set
in the configuration, but you can also install them like ADOdb and Log
somewhere in the php include path.
For historical reasons the path to the LetoDMS_Core and LetoDMS_Lucene package
can still be set
in the configuration, which is not recommend anymore. Just leave those
parameters empty.
1. Using the installation tool
------------------------------
Unpack LetoDMS-<version>.tar.gz and LetoDMS_Core-<version>.tar.gz on
your web server. For the full text search engine support, you will also
need to unpack LetoDMS_Lucene-<version>.tar.gz. For the following instructions
we will assume the files of LetoDMS-<version>.tar.gz are accessible through
Unpack seeddms-<version>.tar.gz below the document root of
your web server.
Install `LetoDMS_Preview-<version>.tar.gz` and
`LetoDMS_Core-<version>.tar.gz` either as a regular pear package or
set up a file system structure like pear did somewhere on you server.
For the full text search engine support, you will also
need to install `LetoDMS_Lucene-<version>.tar.gz`.
For the following instructions we will assume a structure like above
and seeddms-<version> being accessible through
http://localhost/seeddms/
* Point you web browser towards http://hostname/seeddms/install/
* Follow the instructions on the page and create a file ENABLE_INSTALL_TOOL
* Follow the instructions on the page and create a file `ENABLE_INSTALL_TOOL`
in the conf directory.
* Create a data directory with the two sub directories staging and lucene.
* Create a data directory with the thre sub directories staging, cache
and lucene.
Make sure the data directory is either *not* below your document root
or is protected with a .htaccess file against web access. The data directory
needs to be writable by the web server.
@ -121,31 +154,62 @@ http://localhost/seeddms/
-------------------------------------------------------
You need a working web server with MySQL/PHP5 support and the files
LetoDMS-<version>.tar.gz and LetoDMS_Core-<version>.tgz. For the
`SeedDMS-<version>.tar.gz`, `LetoDMS_Preview-<version>.tar.gz` and
`LetoDMS_Core-<version>.tgz`. For the
full text search engine support, you will also need to unpack
LetoDMS_Lucene-<version>.tgz.
`LetoDMS_Lucene-<version>.tgz`.
* Unpack all the files in a public web server folder. If you're working on
a host machine your provider will tell you where to upload the files.
If possible do not unpack LetoDMS_Core-<version>.tgz and
LetoDMS_Lucene-<version>.tgz. below the document root of your web server.
Since they are pear packages they can also be installed with 'pear install
LetoDMS_Core-<version>.tgz' and 'pear install LetoDMS_Lucene-<version>.tgz'
If possible, do not unpack the pear packages `LetoDMS_Core-<version>.tgz`,
`LetoDMS_Preview-<version>.tgz` and
`LetoDMS_Lucene-<version>.tgz` below the document root of your web server.
Choose a temporary folder, as the files will be moved in a second.
* Unless ADODB is not already installed on your system, download
(http://adodb.sourceforge.net/) and unpack it in the SeedDMS
directory
Create a directory e.g. `pear` in the same directory where you unpacked
seeddms and create a sub directory LetoDMS. Move the content except for the
`tests` directory of all LetoDMS pear
packages into that directory. Please note that `pear/LetoDMS` may not
(and for security reasons should not) be below your document root.
You will end up with a directory structure like the following
> seeddms-<version>
> pear
> LetoDMS
> Core.php
> Core
> Lucene.php
> Lucene
> Preview
> Preview.php
Since they are pear packages they can also be installed with
> pear install LetoDMS_Core-<version>.tgz
> pear install LetoDMS_Lucene-<version>.tgz
> pear install LetoDMS_Preview-<version>.tgz
* The PEAR package Log is also needed. It can be downloaded from
http://pear.php.net/package/Log. Unpack it a place where it can be
found by php.
http://pear.php.net/package/Log. Either install it as a pear package
or place it under your new directory 'pear'
> pear
> Log
> Log.php
* The package HTTP_WebDAV_Server is also needed. It can be downloaded from
http://pear.php.net/package/HTTP_WebDAV_Server. Unpack it a place where
it can be found by php.
http://pear.php.net/package/HTTP_WebDAV_Server. Either install it as a
pear package or place it under your new directory 'pear'
> pear
> HTTP
> WebDAV
> Server
> Server.php
* Create a data folder somewhere on your web server including the subdirectories
staging and lucene and make sure they are writable by your web server,
staging, cache and lucene and make sure they are writable by your web server,
but not accessible through the web.
For security reason the data folder should not be inside the public folders
@ -160,15 +224,18 @@ If you install SeedDMS for the first time continue with the database setup.
e.g. for mysql:
grant all privileges on seeddms.* to seeddms@localhost identified by 'secret';
(replace 'secret' with you own password)
* Optionally import "create_tables.sql" in the new database
* Optionally import `create_tables-innodb.sql` in the new database
e.g. for mysql:
cat create_tables.sql | mysql -useeddms -p seeddms
> cat create_tables-innodb.sql | mysql -useeddms -p seeddms
This step can also be done by the install tool.
* create a file ENABLE_INSTALL_TOOL in the conf directory and point
your browser at http://host/<seeddms-dir>/install
* create a file `ENABLE_INSTALL_TOOL` in the conf directory and point
your browser at http://hostname/seeddms/install
NOTE: UPDATING FROM A PREVIOUS VERSION
NOTE: UPDATING FROM A PREVIOUS VERSION OR LETODMS
As SeedDMS is a smooth continuation of LetoDMS there is no difference
in updating from LetoDMS or SeedDMS
- make a backup archive of your installation folder
- make a backup archive of your data folder
@ -177,35 +244,14 @@ NOTE: UPDATING FROM A PREVIOUS VERSION
- edit the conf/settings.xml file to match your previuos settings
(you can even replace the file with your own one eventualy adding by hand
the missing new parameters)
- create a file ENABLE_INSTALL_TOOL in the conf directory and point
your browser at http://host/<seeddms-dir>/install
- create a file `ENABLE_INSTALL_TOOL` in the conf directory and point
your browser at http://hostname/seeddms/install
The install tool will detect the version of your current SeedDMS installation
and run the required database updates.
3. Requirements
---------------
SeedDMS is a web-based application written in PHP. It uses the MySQL RDBMS to
manage the documents that were uploaded into the application.
Make sure you have PHP 5.0 and MySQL 5 or higher installed. SeedDMS
will work with PHP running in CGI-mode as well as running as module under
apache. If you want to give your users the opportunity of uploading passport
photos you have to enable the gd-library (but the rest of SeedDMS will
work without gd, too).
You will also need to download and install the ADODB database
abstraction library from http://adodb.sf.net/ unless it is not installed
on your system already. The webdav server uses the pear packages 'Log' and
'HTTP_WebDAV_Server'. Both can be downloaded from http://pear.php.net.
If you plan to use the full text search engine you will have to install
the zend framework, too.
4. Email Notification
3. Email Notification
---------------------
A notification system allows users to receive an email when a
@ -221,39 +267,10 @@ their notification subscriptions. This can be found in the "My Account"
section under "Notification List".
5. Auto-conversion to HTML
--------------------------
Version 1.3.0 introduces a new feature: Documents can automatically be
converted to HTML when uploading.
You can enable this feature by setting enableConverting (in
settings.xml) to true.
You will also need to edit convertFileTypes (again in
settings.xml). This array defines which file-types are converted
and how.
Under windows Word-, Excel- and Powerpoint-Files are automatically
converted using js-Scipts and MS-Office. I tested it with Office 2000
and it worked just fine.
Under Linux mswordview is used to convert Word-Files by default.
Warning: Getting this feature working can be very tricky but if it
works it is a great enhancement I think.
Especially IIS could cause problems with its IIS-Guest-Account not
having enough rights to execute Word or Excel...
You will also have to edit your httpd.conf to be able to view the converted
files online. Load mod_rewrite and add to following lines to your conf:
RewriteEngine on
RewriteCond %{REQUEST_URI} (.*)viewonline/([0-9]+)/([0-9]+)/(.+)$
RewriteRule (.*)viewonline/([0-9]+)/([0-9]+)/(.+)$ $1op.ViewOnline.php?request=$2:$3 [PT]
IIS Users can download the IIS Rewrite Engine for example:
http://www.qwerksoft.com/products/iisrewrite/
6. Nearly finished
4. Nearly finished
------------------
Now point your browser to http://your.server.com/seedDMS-<version>/index.php
Now point your browser to http://hostname/seeddms/index.php
and login with "admin" both as username and password.
After having logged in you should first choose "My Account" and
change the Administrator's password and email-address.
@ -293,23 +310,29 @@ instance needs its own directory.
Go into that directory create the following links (<seeddms-source> is the
directory of your initial SeedDMS intallation).
src -> <seeddms-source>
inc -> src/inc
op -> src/op
out -> src/out
languages -> src/languages
styles -> src/styles
install -> src/install
index.php -> src/index.php
> src -> <seeddms-source>
> inc -> src/inc
> op -> src/op
> out -> src/out
> js -> src/js
> views -> src/views
> languages -> src/languages
> styles -> src/styles
> themes -> src/themes
> install -> src/install
> index.php -> src/index.php
ln -s ../seeddms-<version>
ln -s src/inc inc
ln -s src/op op
ln -s src/out out
ln -s src/languages languages
ln -s src/styles styles
ln -s src/install install
ln -s src/index.php index.php
> ln -s ../seeddms-<version>
> ln -s src/inc inc
> ln -s src/op op
> ln -s src/out out
> ln -s src/js js
> ln -s src/views views
> ln -s src/languages languages
> ln -s src/styles styles
> ln -s src/themes themes
> ln -s src/install install
> ln -s src/index.php index.php
Create a new directory named conf and run the installation tool.
@ -331,7 +354,7 @@ LICENSING
SeedDMS is licensed unter GPLv2
Jumploader is licensed as stated by the author on th web site
(http://jumploader.com/)
<http://jumploader.com/>
-- Taken from web site of jumploader ---
You may use this software for free, however, you should not:
@ -340,4 +363,6 @@ You may use this software for free, however, you should not:
- Alter or replace class and/or resource files.
- Redistribute this software under different name or authority.
If you would like a customized version, I can do this for a fee. Don’t hesitate to contact me with questions or comments.
If you would like a customized version, I can do this for a fee. Don't hesitate to contact me with questions or comments.
Uwe Steinmann <info@seeddms.org>