README - 27.06.2017
Doctor-Doc is a web based and a easy-to-use tracking and
managing system for scientific literature.
Copyright (C) 2005 - 2017 Markus Fischer, Pascal Steiner
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; version 2 of the License.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
MA 02110-1301, USA.
Contact: info@doctor-doc.com
There are two mailing lists available for Doctor-Doc:
https://sourceforge.net/projects/doctor-doc/support
We strongly encourage you to get involved!
---
Minimal requirements:
Tomcat
Java 8 (services of NLM over SSL require > Java 6)
MySQL > 5.0
For MySQL >= 5.7 add in /etc/mysql/my.cnf
[mysqld]
sql_mode = "STRICT_TRANS_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
(basically remove NO_ZERO_IN_DATE, NO_ZERO_DATE, ONLY_FULL_GROUP_BY)
---
Installation / Configuration:
To install Doctor-Doc in a development environment or to build a war
file, take a look at how-to-checkout.txt
1. Database
Use master_dump.sql under /db to create the database and
a demo-account
---
2. Configuration
In /source/resources/SystemConfiguration.properties please enter the
appropriate configurations for your system.
-
Doctor-Doc uses UTF-8 encoded URIs. Add the parameter URIEncoding="UTF-8"
to the Connector configuration in Tomcats server.xml:
<Connector port="... URIEncoding="UTF-8" />
-
Change in struts-config.xml the port numbers needed for you environment:
<plug-in className="org.apache.struts.action.SecurePlugIn">
<set-property property="httpPort" value="8080"/>
<set-property property="httpsPort" value="8443"/>
<set-property property="enable" value="true"/>
<set-property property="addSession" value="true"/>
</plug-in>
-
To use a custom icon for your institution replace /img/sp.gif.
---
3. Build a war-file using the predefined build.xml with Ant.
Deploy the war-file in the webapps-folder of your Tomcat installation.
---
4. Login
https://{name-of-your-server}:{tomcat-portnumber}/{name-of-the-war-file}/login.do
staff@doctor-doc.com / staff as librarian
user@doctor-doc.com / user as patron (with login permission)
You may change the account information completely to use the system in a
productive environment. Please change the default passwords and emails,
or delete the users!
---
5. SSL
To use SSL for the login process, change in the plugin section of
struts-config.xml the port numbers needed for you environment:
<plug-in className="org.apache.struts.action.SecurePlugIn">
<set-property property="httpPort" value="80"/>
<set-property property="httpsPort" value="443"/>
<set-property property="enable" value="true"/>
<set-property property="addSession" value="true"/>
</plug-in>
Set also all existing entries in struts-config.xml with
<set-property property="secure" value="false"/> to <set-property property="secure" value="true"/>
Configure Tomcat's server.xml with an additional connector like this:
<Connector port="443" protocol="HTTP/1.1" SSLEnabled="true"
maxThreads="150" scheme="https" secure="true"
clientAuth="false" sslProtocol="TLS"
keystoreFile="/path/to/tomcatkeystore"
keystorePass="mySecretPassword" URIEncoding="UTF-8" />
Make sure to use URIEncoding="UTF-8"! And of course you need a valid keystore...