Added this file for documentation of maintenance tasks
[mir.git] / doc / INSTALL.mir
index dfd7af2..58d747d 100755 (executable)
@@ -9,31 +9,54 @@ prerequisites:
 - ant (a java-based make) 
 
 
-1. checkout the cvs: 
-cvs -d :pserver: cvsanon@brazil.indymedia.de:/var/cvs login 
-password: cvs 
-cvs -d :pserver: cvsanon@brazil.indymedia.de:/var/cvs lco mir 
+1. checkout the cvs
+
+CVS LOGIN:
+
+       cvs -d :pserver: cvsanon@brazil.indymedia.de:/var/cvs login 
+       password: cvs 
+
+CVS CHECKOUT:
+
+       cvs -d :pserver: cvsanon@brazil.indymedia.de:/var/cvs co mir 
+
 
 2. customize the config: 
-cd mir/source 
-cp config.properties-dist to config.properties 
-edit config.properties 
 
-3. configure the build.sh file with java_home 
+       cd mir/source 
+       cp config.properties-dist config.properties 
+
+now customize config.properties for your needs.
+
+
+3. configure the build.sh file with java_home
+        cp build.sh-dist build.sh 
+        chmod 755 build.sh
 
-4. Link in the webapps directory of tomcat to the install directory (the directory is called Mir). 
 
-5. copy the mir/template-dist-directory to mir/template 
+4. copy the mir/template-dist-directory to mir/template 
 
-6. run sh buil.sh 
 
-7. create a new database (the dbname should be the same as in config.properties) 
-as user postgres: createdb dbname 
+5. compile
+       sh build.sh 
 
-8. run psql dump of create_pg.sql: 
-psql -Upostgres dbname < create_pg.sql 
 
-8. run psql dump of help*.sql files. 
+6. Link in the webapps directory of tomcat to the install directory (the 
+directory is called "Mir" and is located in the same directory in which 
+you installed the "mir" directory). 
+       cd /usr/share/tomcat/webapps
+       ln -s Mir-install-dir Mir
+
+
+7. create a new database 
+the database name should be the same as in config.properties
+as user postgres: 
+       createdb dbname 
+
+
+8. create base table
+       psql -Upostgres dbname < dbscripts/create_pg.sql
+       cat dbscript/help*.sql | psql -Upostgres dbname
 
 9. chmod 777 Mir/log 
 
@@ -41,4 +64,57 @@ psql -Upostgres dbname < create_pg.sql
 
 11. configure mod_jk 
 
-12. now the admin-application is accesable by:  http://host/Mir and the openposting-servlet by  http://host/OpenMir>
+insert the following patch into /etc/apache/httpd.conf. Edit the directories
+to suit your needs.
+
+<IfModule mod_jk.c>
+JkWorkersFile /usr/share/tomcat/conf/workers.properties
+Include /usr/share/tomcat/conf/mod_jk.conf-auto
+</IfModule>
+
+Do not put any JkMount lines into your httpd.conf!
+
+If mod_jk.conf-auto doesn't get written or is 0 bytes in size, check your
+system for file ownership/permissions problems.
+
+
+12. Add a password to your PostgreSQL user and link it to Mir (optional)
+
+Add a hard to guess password to the PostgreSQL user database:
+
+# psql -U postgres Mir
+alter user postgres with password 'yourpassword';
+
+
+Then, in /etc/postgresql/pg_hba.conf you should make sure that nobody can
+use the database without a password:
+
+local           all                                                                               password
+host         all         127.0.0.1     255.0.0.0           password
+host         all         0.0.0.0       0.0.0.0             reject
+
+
+Then, change the database password line in config.properties:
+
+Database.Username=postgres
+Database.Password=yourpassword
+
+You should make sure that no copy of config.properties (neither in mir nor
+in Mir/src nor in Mir/WEB-INF/classes) is world-readable. Else you wouldn't
+have to install a password, anyway.
+
+If you can't access PostgreSQL after this for any reason, try to change
+"password" in /etc/postgresql/pg_hba.conf into "trust". This should disable
+any authentication method and make the database accessible again.
+
+that's it :)
+
+now the admin-application is accesable via:  
+
+       http://host/Mir 
+
+and the openposting-servlet via  
+       
+       http://host/OpenMir
+
+standard login is redaktion/indymedia