From: <re...@us...> - 2008-08-24 23:16:50
|
Revision: 632 http://sciret.svn.sourceforge.net/sciret/?rev=632&view=rev Author: reinerj Date: 2008-08-24 23:16:45 +0000 (Sun, 24 Aug 2008) Log Message: ----------- update also the docs to the monkeys Modified Paths: -------------- trunk/docs/build-sciret-doc.sh trunk/docs/sciret-install-EN-html4.html trunk/docs/sciret-install-EN-html4.txt trunk/docs/sciret-install-EN-images.html trunk/docs/sciret-install-EN-images.txt trunk/docs/sciret-install-EN.html trunk/docs/sciret-install-EN.txt trunk/docs/sciret-install-OpenBSD-EN-html4.html trunk/docs/sciret-install-OpenBSD-EN-images.html trunk/docs/sciret-install-OpenBSD-EN.html Added Paths: ----------- trunk/docs/sciret-install-OpenBSD-EN-images.txt Modified: trunk/docs/build-sciret-doc.sh =================================================================== --- trunk/docs/build-sciret-doc.sh 2008-08-24 20:06:14 UTC (rev 631) +++ trunk/docs/build-sciret-doc.sh 2008-08-24 23:16:45 UTC (rev 632) @@ -20,9 +20,9 @@ # # COPYRIGHT: # -# Copyright (C) 2005-2007 TheGang http://www.the-gang.net +# Copyright (C) 2005-2008 Keyboard Monkeys http://www.kb-m.com/ # License http://www.fsf.org/copyleft/lgpl.html GNU Lesser General Public License -# Author Reiner Jung <rj...@th...> +# Author Reiner Jung <re...@kb...> # # TODO # Modified: trunk/docs/sciret-install-EN-html4.html =================================================================== --- trunk/docs/sciret-install-EN-html4.html 2008-08-24 20:06:14 UTC (rev 631) +++ trunk/docs/sciret-install-EN-html4.html 2008-08-24 23:16:45 UTC (rev 632) @@ -9,12 +9,12 @@ <h1>Howto install the Sciret Knowledge Base</h1> <p> <strong>v1.1.4, July 2007</strong><br /> -Reiner Jung <rj...@th...> +Reiner Jung <re...@kb...> </p> <hr /> <h2>1. Introduction</h2> <p>Sciret is an advanced knowledge based system written in PHP. The software self is platform independent and should run on every platform where PHP is supported. In the further development, Sciret will be extended to a full enterprise knowledge and information storage system.</p> -<p>Sciret was developed as a internal project from <a href="http://www.the-gang.net">TheGang</a>, a Open Source consulting and strategy company. After many month of internal usage, the decision was taken to release the code as an Open Source Project on <a href="http://www.sf.net">Sourceforge</a>. We hope that Sciret will also fulfill the requirements of other users and companies.</p> +<p>Sciret was developed as a internal project from <a href="http://www.kb-m.com">Keyboard ,onkeys</a>, a Open Source consulting and strategy company. After many month of internal usage, the decision was taken to release the code as an Open Source Project on <a href="http://www.sf.net">Sourceforge</a>. We hope that Sciret will also fulfill the requirements of other users and companies.</p> <p><b>Important:</b> Some of the information of this document are not related to your Sciret version. Please read also the release announcements for your version!</p> <hr /> <h2>2. Requirements</h2> @@ -497,7 +497,7 @@ <p></p> <p></p> <hr /><p><small> -Last updated 28-Jul-2007 10:11:34 CEST +Last updated 25-Aug-2008 01:16:12 CEST </small></p> </body> </html> Modified: trunk/docs/sciret-install-EN-html4.txt =================================================================== --- trunk/docs/sciret-install-EN-html4.txt 2008-08-24 20:06:14 UTC (rev 631) +++ trunk/docs/sciret-install-EN-html4.txt 2008-08-24 23:16:45 UTC (rev 632) @@ -1,14 +1,14 @@ Howto install the Sciret Knowledge Base ======================================= v1.1.4, July 2007 -Reiner Jung <rj...@th...> +Reiner Jung <re...@kb...> :Author Initials: JR Introduction ------------ Sciret is an advanced knowledge based system written in PHP. The software self is platform independent and should run on every platform where PHP is supported. In the further development, Sciret will be extended to a full enterprise knowledge and information storage system. -Sciret was developed as a internal project from http://www.the-gang.net[TheGang], a Open Source consulting and strategy company. After many month of internal usage, the decision was taken to release the code as an Open Source Project on http://www.sf.net[Sourceforge]. We hope that Sciret will also fulfill the requirements of other users and companies. +Sciret was developed as a internal project from http://www.kb-m.com[Keyboard ,onkeys], a Open Source consulting and strategy company. After many month of internal usage, the decision was taken to release the code as an Open Source Project on http://www.sf.net[Sourceforge]. We hope that Sciret will also fulfill the requirements of other users and companies. IMPORTANT: Some of the information of this document are not related to your Sciret version. Please read also the release announcements for your version! Modified: trunk/docs/sciret-install-EN-images.html =================================================================== --- trunk/docs/sciret-install-EN-images.html 2008-08-24 20:06:14 UTC (rev 631) +++ trunk/docs/sciret-install-EN-images.html 2008-08-24 23:16:45 UTC (rev 632) @@ -304,12 +304,12 @@ <div id="header"> <h1>Howto install the Sciret Knowledge Base</h1> <span id="author">v1.1.4, July 2007</span><br /> -Reiner Jung <rj...@th...> +Reiner Jung <re...@kb...> </div> <h2>1. Introduction</h2> <div class="sectionbody"> <p>Sciret is an advanced knowledge based system written in PHP. The software self is platform independent and should run on every platform where PHP is supported. In the further development, Sciret will be extended to a full enterprise knowledge and information storage system.</p> -<p>Sciret was developed as a internal project from <a href="http://www.the-gang.net">TheGang</a>, a Open Source consulting and strategy company. After many month of internal usage, the decision was taken to release the code as an Open Source Project on <a href="http://www.sf.net">Sourceforge</a>. We hope that Sciret will also fulfill the requirements of other users and companies.</p> +<p>Sciret was developed as a internal project from <a href="http://www.kb-m.com">Keyboard ,onkeys</a>, a Open Source consulting and strategy company. After many month of internal usage, the decision was taken to release the code as an Open Source Project on <a href="http://www.sf.net">Sourceforge</a>. We hope that Sciret will also fulfill the requirements of other users and companies.</p> <div class="admonitionblock"> <table><tr> <td class="icon"> @@ -1099,7 +1099,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 28-Jul-2007 10:11:36 CEST +Last updated 25-Aug-2008 01:16:13 CEST </div> </div> </body> Modified: trunk/docs/sciret-install-EN-images.txt =================================================================== --- trunk/docs/sciret-install-EN-images.txt 2008-08-24 20:06:14 UTC (rev 631) +++ trunk/docs/sciret-install-EN-images.txt 2008-08-24 23:16:45 UTC (rev 632) @@ -1,14 +1,14 @@ Howto install the Sciret Knowledge Base ======================================= v1.1.4, July 2007 -Reiner Jung <rj...@th...> +Reiner Jung <re...@kb...> :Author Initials: JR Introduction ------------ Sciret is an advanced knowledge based system written in PHP. The software self is platform independent and should run on every platform where PHP is supported. In the further development, Sciret will be extended to a full enterprise knowledge and information storage system. -Sciret was developed as a internal project from http://www.the-gang.net[TheGang], a Open Source consulting and strategy company. After many month of internal usage, the decision was taken to release the code as an Open Source Project on http://www.sf.net[Sourceforge]. We hope that Sciret will also fulfill the requirements of other users and companies. +Sciret was developed as a internal project from http://www.kb-m.com[Keyboard ,onkeys], a Open Source consulting and strategy company. After many month of internal usage, the decision was taken to release the code as an Open Source Project on http://www.sf.net[Sourceforge]. We hope that Sciret will also fulfill the requirements of other users and companies. IMPORTANT: Some of the information of this document are not related to your Sciret version. Please read also the release announcements for your version! Modified: trunk/docs/sciret-install-EN.html =================================================================== --- trunk/docs/sciret-install-EN.html 2008-08-24 20:06:14 UTC (rev 631) +++ trunk/docs/sciret-install-EN.html 2008-08-24 23:16:45 UTC (rev 632) @@ -304,12 +304,12 @@ <div id="header"> <h1>Howto install the Sciret Knowledge Base</h1> <span id="author">v1.1.4, July 2007</span><br /> -Reiner Jung <rj...@th...> +Reiner Jung <re...@kb...> </div> <h2>1. Introduction</h2> <div class="sectionbody"> <p>Sciret is an advanced knowledge based system written in PHP. The software self is platform independent and should run on every platform where PHP is supported. In the further development, Sciret will be extended to a full enterprise knowledge and information storage system.</p> -<p>Sciret was developed as a internal project from <a href="http://www.the-gang.net">TheGang</a>, a Open Source consulting and strategy company. After many month of internal usage, the decision was taken to release the code as an Open Source Project on <a href="http://www.sf.net">Sourceforge</a>. We hope that Sciret will also fulfill the requirements of other users and companies.</p> +<p>Sciret was developed as a internal project from <a href="http://www.kb-m.com">Keyboard ,onkeys</a>, a Open Source consulting and strategy company. After many month of internal usage, the decision was taken to release the code as an Open Source Project on <a href="http://www.sf.net">Sourceforge</a>. We hope that Sciret will also fulfill the requirements of other users and companies.</p> <div class="admonitionblock"> <table><tr> <td class="icon"> @@ -1099,7 +1099,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 28-Jul-2007 10:11:32 CEST +Last updated 25-Aug-2008 01:16:10 CEST </div> </div> </body> Modified: trunk/docs/sciret-install-EN.txt =================================================================== --- trunk/docs/sciret-install-EN.txt 2008-08-24 20:06:14 UTC (rev 631) +++ trunk/docs/sciret-install-EN.txt 2008-08-24 23:16:45 UTC (rev 632) @@ -1,14 +1,14 @@ Howto install the Sciret Knowledge Base ======================================= v1.1.4, July 2007 -Reiner Jung <rj...@th...> +Reiner Jung <re...@kb...> :Author Initials: JR Introduction ------------ Sciret is an advanced knowledge based system written in PHP. The software self is platform independent and should run on every platform where PHP is supported. In the further development, Sciret will be extended to a full enterprise knowledge and information storage system. -Sciret was developed as a internal project from http://www.the-gang.net[TheGang], a Open Source consulting and strategy company. After many month of internal usage, the decision was taken to release the code as an Open Source Project on http://www.sf.net[Sourceforge]. We hope that Sciret will also fulfill the requirements of other users and companies. +Sciret was developed as a internal project from http://www.kb-m.com[Keyboard ,onkeys], a Open Source consulting and strategy company. After many month of internal usage, the decision was taken to release the code as an Open Source Project on http://www.sf.net[Sourceforge]. We hope that Sciret will also fulfill the requirements of other users and companies. IMPORTANT: Some of the information of this document are not related to your Sciret version. Please read also the release announcements for your version! Modified: trunk/docs/sciret-install-OpenBSD-EN-html4.html =================================================================== --- trunk/docs/sciret-install-OpenBSD-EN-html4.html 2008-08-24 20:06:14 UTC (rev 631) +++ trunk/docs/sciret-install-OpenBSD-EN-html4.html 2008-08-24 23:16:45 UTC (rev 632) @@ -547,7 +547,7 @@ <p></p> <p></p> <hr /><p><small> -Last updated 28-Jul-2007 10:11:39 CEST +Last updated 25-Aug-2008 01:16:17 CEST </small></p> </body> </html> Modified: trunk/docs/sciret-install-OpenBSD-EN-images.html =================================================================== --- trunk/docs/sciret-install-OpenBSD-EN-images.html 2008-08-24 20:06:14 UTC (rev 631) +++ trunk/docs/sciret-install-OpenBSD-EN-images.html 2008-08-24 23:16:45 UTC (rev 632) @@ -1208,7 +1208,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 28-Jul-2007 10:11:41 CEST +Last updated 25-Aug-2008 01:16:18 CEST </div> </div> </body> Added: trunk/docs/sciret-install-OpenBSD-EN-images.txt =================================================================== --- trunk/docs/sciret-install-OpenBSD-EN-images.txt (rev 0) +++ trunk/docs/sciret-install-OpenBSD-EN-images.txt 2008-08-24 23:16:45 UTC (rev 632) @@ -0,0 +1,673 @@ +Howto install Sciret on OpenBSD +=============================== +v1.1.3, Mai 2007 +Reiner Jung <rj...@th...> +:Author Initials: JR + +Introduction +------------ + +*Sciret* + +Sciret is an advanced knowledge based system written in PHP. The software self is platform independent and should run on every platform where PHP is supported. In the further development, Sciret will be extended to a full enterprise knowledge and information storage system. + +Sciret was developed as a internal project from http://www.the-gang.net[TheGang], a Open Source consulting and strategy company. After many month of internal usage, the decision was taken to release the code as an Open Source Project on http://www.sf.net[Sourceforge]. We hope that Sciret will also fulfill the requirements of other users and companies. + +*OpenBSD* + +http://www.openbsd.org[OpenBSD] is a Unix-like computer operating system descended from Berkeley Software Distribution (BSD), a Unix derivative developed at the University of California, Berkeley. It was forked from NetBSD by project leader Theo de Raadt in late 1995. The project is widely known for the developers insistence on open source code and quality documentation; uncompromising position on software licensing; and focus on security and code correctness. The project is coordinated from de Raadt's home in Calgary, Alberta, Canada. Its logo and mascot is Puffy, a blowfish. + +OpenBSD includes a number of security features absent or optional in other operating systems and has a tradition of developers auditing the source code for software bugs and security problems. The project maintains strict policies on licensing and prefers the open source BSD licence and its variants in the past this has led to a comprehensive licence audit and moves to remove or replace code under licences found less acceptable. + +OpenBSD is developed by volunteers. The project funds development and releases by selling http://openbsd.org/items.html[CDs] and http://openbsd.org/tshirts.html[T-shirts], as well as http://openbsd.org/donations.html[donations] from organizations and individuals. These finances ensure that OpenBSD will continue to exist, and will remain http://openbsd.org/policy.html[free] for everyone to use and reuse as they see fit. + +IMPORTANT: Some of the information of this document are not related to your Sciret version. Please read also the release announcements for your version! + +Requirements +------------ + +To install Sciret, you need a couple of things enabled or installed + +*Operation system*:: http://www.OpenBSD.org[OpenBSD] + +*Web Server*:: http://httpd.apache.org[OpenBSD Apache Web Server] included in the core OS from OpenBSD + +*PHP*:: http://www.php.net/[PHP] version 5.x + +*MySQL*:: http://mysql.com/[MySQL database] + +Install the Operation System, the required packages and the configuration of the system +--------------------------------------------------------------------------------------- + +We will not explain here how to install OpenBSD as OpenBSD is mostly self-explained. Information howto install OpenBSD you can found on the OpenBSD project web site. A typical installation from OpenBSD is done in less then 10 minutes when you follow the excellent http://www.openbsd.org/faq/faq4.html[instructions]. + +After the base system in installed, you need to configure several parts to run Sciret. + +[TIP] +.Prepare to install OpenBSD packages +===================================================================================== +You can install the additional packages over HTTP or FTP. Please add as root user +the follow information to the file *.profile* + + # vi /root/.profile + + # export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/$(uname -r)/packages/$(uname -m)/" + +You must logout and login from the Shell to activate the environment variables +===================================================================================== + +Now you can begin to install the additional packages, which are not part of your core +OpenBSD system. The PHP packages from OpenBSD are patched with +http://www.hardened-php.net/suhosin.127.html[Suhosin] for better security. + +[IMPORTANT] +.Install the required packages +===================================================================================== + +Install the MySQL server with + + # pkg_add -v -i mysql-server + +Install the PHP package + + # pkg_add -v -i php5-core + +Copy the php.ini file + + # cp /usr/local/share/examples/php5/php.ini-recommended /var/www/conf/php.ini + +Edit the php.ini file + + # vi /var/www/conf/php.ini + +And change the value from + + short_open_tag = off + +to + + short_open_tag = on + +And activate the PHP package + + # /usr/local/sbin/phpxs -s + +And install and activate the follow packages also + + # pkg_add -v -i php5-mysql + + # /usr/local/sbin/phpxs -a mysql + + # pkg_add -v -i php5-mcrypt + + # /usr/local/sbin/phpxs -a mcrypt + + # pkg_add -v -i php5-mhash + + # /usr/local/sbin/phpxs -a mhash + + # pkg_add -v -i php5-imap + + # /usr/local/sbin/phpxs -a imap/ +===================================================================================== + +After the packages are installed, you need to prepare the OpenBSD Apache to support PHP +and you need to create the /tmp directory for Sciret. The /tmp directory is required as +the OpenBSD Apache runs in a Chroot environment. + +[IMPORTANT] +.Configure OpenBSD Apache web server +===================================================================================== +To enable parsing of PHP scripts, add the following to /var/www/conf/httpd.conf: + + AddType application/x-httpd-php .php + +and add index.php to your DirectoryIndex that it looks like + + DirectoryIndex index.html index.php + +Now you need to create the /tmp directory for Apache with the follow commands + + # mkdir /var/www/tmp + # chown www /var/www/tmp + +The base configuration from the Apache server is finished. Now you need to activate +the webserver that he start on system start. Please change in the file */etc/rc.conf* +the value from + + http_flags=NO + +to + + http_flags="" +===================================================================================== + +PHP and the Apache web server are up and running and the first part of your installation +was successful finished. You can test now that there was no error in the configuration +until now. + +[TIP] +.Test the PHP and Apache functionality +===================================================================================== +Create the following file + + # vi /var/www/htdocs/info.php + +and add to this file the follow line + + <? + phpinfo(); + ?> + +Now start your apache web server from the command line with the command + + # apachectl start + +and point your browser to the follow addess + + http://your-server-ip-address/info.php + +When you see the PHP information, your web server and the PHP installation are working +and you can go to the next step. Please *delete* the info.php file before you continue. + + # rm /var/www/htdocs/info.php +===================================================================================== + +Now you need to prepare your MySQL server that he start at system start and you need to +install the default database for your MySQL server. + +[IMPORTANT] +.Configuration of your MySQL server +===================================================================================== +To enable MySQL to start at boot enter the following line in /etc/rc.conf.local: + + mysql=YES + + +Then enter the following lines into your /etc/rc.local *after* the line + + # Add your local startup actions here + +and *before* the line + + echo ´.´ + + + if [ X"${mysql}" == X"YES" -a -x /usr/local/bin/mysqld_safe ]; then + echo -n " mysqld"; /usr/local/bin/mysqld_safe --user=_mysql --log --open-files-limit=256 & + for i in 1 2 3 4 5 6; do + if [ -S /var/run/mysql/mysql.sock ]; then + break + else + sleep 1 + echo -n "." + fi + done + # + # Apache chroot Settings + mkdir -p /var/www/var/run/mysql + sleep 2 + ln -f /var/run/mysql/mysql.sock /var/www/var/run/mysql/mysql.sock + fi + +You must add this line exactly as they are written here. Otherwise your chrooted Apache will not be +able to connect to the MySQL Database server! +===================================================================================== + +The basic installation from your OpenBSD system and the required servers are configured and you can +start now to install Sciret. Sciret will be available in the OpenBSD ports tree, so you can install +Sciret without pain. Before you can install Sciret, you need to prepare your database first. Please +follow the instructions below. + +Database +-------- + +Sciret requires a database. At the moment Sciret support only MySQL as database. +There are several ways to create a database and several tools + +[TIP] +.MySQL Administration +================================================================================ +phpMyAdmin: Web based administration tool for MySQL is as a package available in +the OpenBSD ports tree. You can install the package like the other packages with +the command + + pkg_add -v -i phpMyAdmin. + +For more information about phpMyAdmin you can visit the project page. + +http://www.phpmyadmin.net[http://www.phpmyadmin.net/] + +MySQL Administrator is a other tool, provided by MySQL AB and this tool is also +available as package from the ports tree (mysql-administrator). + +http://www.mysql.com/products/tools/administrator[http://www.mysql.com/products/tools/administrator/] +================================================================================ + +Disabling and configuring Services +---------------------------------- + +OpenBSD does come with a few unnecessary services enabled by default, which you don't need when you run Sciret. Turn these services off. This is completely optional and you must do so according to your own needs. + +[TIP] +.Disable unnecessary service +================================================================================ +Edit the following file + + # vi /etc/inetd.conf + +and comment out the following line: + + #ident stream tcp nowait _identd /usr/libexec/identd identd -el + #ident stream tcp6 nowait _identd /usr/libexec/identd identd -el + #daytime stream tcp nowait root internal + #daytime stream tcp6 nowait root internal + #time stream tcp nowait root internal + #time stream tcp6 nowait root internal +================================================================================ + + +Install Sciret from scratch +--------------------------- +When you install Sciret the first time, you should follow the instructions in this manual. + +Create your database and a user which can connect to the DB +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +This example shows how to create a database under OpenBSD from the command line. +With the graphical tools the steps are the same as described here. + +WARNING: Many people run their applications under the MySQL Root account. *Never* use the database Root account as a user for your application. Create instead a dedicated user only for the application. + +.Create the database +.................................................................................... + # mysqladmin –u your-mysqladmin-user –p create sciret-db-name + Enter password: +.................................................................................... + +.Create the Sciret DB user and give him DB access rights +..................................................................................... + # mysql –u your-mysqladmin-user –p + Enter password: + + mysql> grant all on sciret.* to sciret-db-user@localhost identified by “password”; +..................................................................................... + +Install Sciret sources on your web server +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +You can http://sourceforge.net/project/showfiles.php?group_id=181327[download the Sciret sources] from the Project page or you can install the package as OpenBSD user from the OpenBSD ports tree direct from the command line. When you want have a preview to upcoming versions of Sciret, You can download the test releases or checkout directly from SVN. + +[TIP] +.The preferred installation from Sciret on OpenBSD +================================================================================================ +You should use to install Sciret the packages available from OpenBSD. To install Sciret run the +follow command. + + # pkd_add -v -i sciret +================================================================================================ + +When you have downloaded the Sources from http://www.sf.net[SourceForge], you must unpack the sources in your web server root. + +.Install the sources +.................................................................... + # cd /var/www/htdocs + + # tar xzvf sciret-rcx-x.x.x.tar.gz +.................................................................... + +After the sources from Sciret are installed on your server. You must change the permissions that your web server can read the files. For the *upload* directory you must give also write permissions to the web server user. + +[TIP] +.Under which user your Apache is running? +================================================================================================ +The OpenBSD apache runs under the user *www*. +================================================================================================ + +.Change the access rights to your web server user +.................................................................... + # cd /var/www/htdocs + + # chown -R root:www sciret + + # find sciret -type d -exec chmod 550 {} \; + + # find sciret -type f -exec chmod 440 {} \; + + # find sciret/uploads -type d -exec chmod 770 {} \; + + # chmod 660 sciret/config.php +.................................................................... + +Now you must set the *$Config['UserFilesPath']* variable to the path (relative to the web server root dir) where +you want to store image uploads. + +.Edit the follow files: +.................................................................... + # vi fckeditor/editor/filemanager/browser/default/connectors/php/config.php + + // Path to user files relative to the document root. + $Config['UserFilesPath'] = '/sciret/uploads/editor' ; + + # vi fckeditor/editor/filemanager/upload/php/config.php + + // Path to uploaded files relative to the document root. + $Config['UserFilesPath'] = '/sciret/uploads/editor' ; +.................................................................... + +Finish the Sciret installation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +After you configured the web server and all permissions are set, you can go to finish the installation. To finalize the Sciret setup, please point your browser to your web server Sciret URL and follow the instructions. + +[NOTE] +.Finalize the installation +========================================= +Point your browser to the URL or your Sciret installation to finalize the installation + +http://www.servername.xx/index.php + +========================================= + +Remove write access to the config file +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +After successful installation from Sciret, you can remove the write access to the config.php from your web server user. + +.Change the access rights from the config.php back +.................................................................... + # chmod 440 sciret/config.php +.................................................................... + +Login to Sciret the first time +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +When you finished your installation, you can login to Sciret the first time. Please take care to change the default password after your first login! + +[IMPORTANT] +.Default login password +======================================== +username = admin + +password = admin +======================================== + +Secure your Sciret access with a web server certificate +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To protect your privacy, you can use a server certificate when you connect to your Sciret installation. With a certificate you can connect to your web server with an encrypted connection (using https instead of http). Without an https connection, other people can sniff your password or other personal information. + +[TIP] +.Self-signed server certificates. +============================================================ + You can self-sign the certificate which you will create. + +*Use a non-Profit Certificate Authority.* + + +http://www.cacert.org/[CAcert] + + +*Use a commercial Certificate Authority.* + +http://www.rapidssl.com/[RapidSSL] + +http://www.geotrust.com/[GeoTrust] + +http://www.thawte.com[Thawte] +============================================================ + + +Use CAcert as Certificate Authority +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +We will here explain the steps, which you need to register and create your certificate with CAcert. The reason for CAcert is not that it is better then the other authorities, the reason is that it is free of charge. + +[NOTE] +.The CAcert homepage +https://www.cacert.org/[https://www.cacert.org] + +What to do first?? +First you must create an account at CAcert. For the account enrolment you must fill out the https://www.cacert.org/index.php?id=1[form]. When you have done this, you will receive a Email with more instructions. + +Register your domain at CAcert?? +After you have created your account, register your domain at CAcert for which you want sign a certificate. When you have already more then 50 assurance points, then you can register your organization. To register your organization, you must send to su...@ca... some scanned copy(ies) of Certificate of Incorporation etc. + +Creating your certificate signing request?? +On your Sciret server, you must create a server key and a certificate-signing request for your web server. + +Sign the Certificate Signing Request?? +You Certificate Signing Request you can now sign on the CAcert website. Please follow the instruction on the site. + +Install the certificate on your server?? +After your certificate is signed, install the Certificate on your server to protect your Sciret installation. + +[TIP] +.How create the certificates +======================================================== +Create you server certificate + + # /usr/sbin/openssl genrsa 1024 > /etc/ssl/private/server.key + +Create your Certificate Signing Request (CSR) + + # usr/sbin/openssl req -new -key /etc/ssl/private/server.key \ + -out /etc/ssl/private/server.csr +======================================================== + +Now your Sciret installation is basically protected again sniffing your password. There are other possibilities to protect your server and install it in a secure way. This will be targeted in a separate document in the future. + +[NOTE] +.Comercial Certificate Vendors +The certificate creation process is similar for a commercial vendor. + +Patch your Sciret installation +------------------------------ + +IMPORTANT: You can only patch the latest Sciret release. When you are not running the latest Sciret release, you need to upgrade your installation. + +Sometimes your Sciret installation needs to be patched to fix a bug. For small bug fixes you can download only the new file to patch you Sciret installation instead to download a new package. + +[NOTE] +.Apply the patch +============================================================================================================================ +Download the patch from the Sciret SourceForge project page + +https://sourceforge.net/project/showfiles.php?group_id=181327[https://sourceforge.net/project/showfiles.php?group_id=181327] + +Overwrite the existing file with the new file +============================================================================================================================ + + +Upgrade the Sciret language package +----------------------------------- + +The Sciret project deliver a separate language package. With this package you can update you stable Sciret installation with additional translation. The reason for the separate package is that some translations are started or committed after a stable release from Sciret is released. To install the Sciret language package, please follow the instructions + +[TIP] +.Install the language package +======================================================== +Download the package from the SourceForge project page + + http://sourceforge.net/project/showfiles.php?group_id=181327&package_id=231283 + +and unpack the package it the folder + + # cd /var/www/htdocs/sciret/languages + +On OpenBSD with + + # tar xzvf language-update-x.x.x.tar.gz +======================================================== + +Install aditional icon sets on Sciret +------------------------------------- + +The Sciret project deliver several icon sets. With these packages you can installation and other icons set as Sciret ship it by default. To install the Sciret icon set package, please follow the instructions + +[TIP] +.Install a alternative icon set +======================================================== +Download the package from the SourceForge project page + + http://sourceforge.net/project/showfiles.php?group_id=181327&package_id=231283 + +make a backup of your standard icon set + + # cd /var/www/htdocs/sciret/uploads/icons + + # tar czvf a-name-for-your-backup.tar.gz * + + # mv a-name-for-your-backup.tar.gz /root/ + + # rm -rf * + +and unpack the new icon set in the same folder + + # tar xzvf name-of-the-new-icon-set.tar.gz +======================================================== + + +Upgrade Sciret +-------------- + +With the release from Sciret 1.1.0, Sciret offer a full automatic upgrade to the next release. The automatic upgrade work only from the last stable release but not from a SVN version of Sciret. + + +IMPORTANT: Before you start any upgrade from Sciret, please *make a backup* from your Sciret database and your Sciret installation! + +Backup your Sciret installation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +We will describe here a simple backup from Sciret. Please consider that on your platform, the backup procedure can be different. + +[WARNING] +.Stop the web server +============================================================ +Before you start to make any backups, you should first stop +the web server. + + # apachectl stop +============================================================ + +.Backup the database and the Sciret web server root +......................................................................................... + # tar czvf sciret.tar.gz sciret + + # mv sciret.tar.gz /root/ + + # mysqldump –u your-mysqladmin-user -p --opt database > /root/database.sql +......................................................................................... + +After you have backed up your installation, you can upgrade the database. + +Now you can install the new sources from Sciret on your web server + +.Upgrade Sciret +......................................................................................... + # cp sciret/config.php /root/ + + # pkg_add -u -i -v sciret + + # cp /root/config.php sciret/ +......................................................................................... + +[NOTE] +.Start the web server +================================================================ +After your upgrade is done, you must start the web server again. + + # apachectl start +================================================================ + +After you have update you must force a reload of your browser cache. Often a update from Sciret includes changes in the JavaScirpt engine or the CSS files. + +[TIP] +.After the package upgrade +================================================================ +Point your browser to the Sciret site and follow the instruction to perform the automatic database upgrade +================================================================ + +[IMPORTANT] +.Upgrade Sciret from a SVN development version +=============================================================== +Before you upgrade Sciret to the latest release, please read the release notes and the file UPGRADE.TXT. Sometimes the database schema is changed and you need to alter your database first before you can upgrade Sciret. + +If you update the code from the svn repository the automatic upgrade won't work since +you are in a kind of "limbo version". The system will only do clean +installs and upgrade from any stable version to the next stable version. To make your +current installs work you'll have, just for this time, to manually run +the SQL that you need under /setup/upgrade_x.x.x.sql and this: +INSERT INTO configuration (field, value) VALUES('version', 'x.x.x'); +=============================================================== + + +Install the Sciret development version +-------------------------------------- +When you want test Sciret and submit patches to Sciret, you should use the development version from Sciret and not the stable version of Sciret. Sciret development from Subversion is not recommended for production use. You must read the Changelog before you install the development version. + +Checkout Sciret from Subversion +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +You can checkout the Sciret sources direct from Subversion on the Sourceforge project page. Please consider that the development version of Sciret have no support. + +.SVN checkout from Sourceforge +......................................................................................... + # svn co https://sciret.svn.sourceforge.net/svnroot/sciret/trunk sciret +......................................................................................... + +Report Bugs, Submit Patches ... +--------------------------------- +When you found any problems with Sciret or inside this howto, please let us know what is going wrong. All problems and patches should be reported to the http://sourceforge.net/project/stats/?group_id=181327&ugn=sciret[Sciret Sourceforge Project Page]. There are also the mailing lists and the forums, which you can use to communicate with other users or the developers from Sciret. + + +[IMPORTANT] +.Important development addresses +=============================================================== +When you report a bug about Sciret, it is important that you send us also the Version number from Sciret. The Version Number you can found in the Sciret root directory in the file VERSION + +http://sourceforge.net/tracker/?group_id=181327&atid=896759[The Sciret Bug Tracker] + +http://sourceforge.net/tracker/?group_id=181327&atid=896762[The Sciret Feature Request Page] + +http://sourceforge.net/tracker/?group_id=181327&atid=896761[The Sciret Patches Submitting Page] +=============================================================== + +Other Information about Sciret +------------------------------- +When you are interested in more information about Sciret, you can also visit the Sciret homepage. Here are screenshots from Sciret published and you can play around with the Sciret demo. + +[TIP] +.Please visit the Sciret homepage at +http://www.sciret.org[http://www.sciret.org] + +Contributors to Sciret development +---------------------------------- +Some people are contributed to the development with patches or with translations. + +Patch contribution +~~~~~~~~~~~~~~~~~~ +- Nikolai Essel submitted patches to Sciret 0.9/1.1 +- Rune Hammersland submitted patches to Sciret 1.1 + +Testers +~~~~~~~ +- Johnny Hsieh + +Translations +~~~~~~~~~~~~ +- Chinese Traditional Johnny Hsieh +- Dutch translation Roy de Milde +- Hebrew translation from SF user Golanor +- Japanese translation from SF user tm800720 +- Norway translation from from Rune Hammersland +- Swedish translation from Henrik Christensson + +Graphical Layout +~~~~~~~~~~~~~~~~ +- The Sciret Logo and the New Sciret Layout is done by Nunu Pinheiro + +Packager +~~~~~~~~ +- OpenBSD Felix Kronlage + +License of this documentation +----------------------------- + +This work is licensed under a http://creativecommons.org/licenses/by-sa/2.5/[Creative Commons Attribution-Share Alike 2.5 License]. + +// vim: set syntax=asciidoc: + Modified: trunk/docs/sciret-install-OpenBSD-EN.html =================================================================== --- trunk/docs/sciret-install-OpenBSD-EN.html 2008-08-24 20:06:14 UTC (rev 631) +++ trunk/docs/sciret-install-OpenBSD-EN.html 2008-08-24 23:16:45 UTC (rev 632) @@ -1208,7 +1208,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 28-Jul-2007 10:11:37 CEST +Last updated 25-Aug-2008 01:16:15 CEST </div> </div> </body> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |