Quickstart

GWiki Install Tutorial

GWiki is fully mavenized, so you need Maven to build the projects.

GWiki is devided in five subprojects:

Name Description Dependencies
gwiki-parent contains the parent pom.xml which includes the global configuration like versionnummer and deployment repository. none
gwiki-genome-dependencies Contains the required classes for Genome. gwiki-parent
gwiki The main project. Contains all to build the *.jar zu bauen! gwiki-genome-dependencies
gwiki-webapp The webproject which is needed to build a *.war file and to start GWiki out of Eclipse. gwiki
gwiki-standalone A Java Project to create a standalone version of GWiki gwiki

Installation steps

Check out all necessary projects and use Maven to build them:

Run mvn install on the projects in this order:

  • gwiki-genome-dependencies
  • gwiki-parent.
  • gwiki
  • gwiki-webapp

If problems appear try to update the project configuration too.

To build the *.jar or *.war files run mvn package on the gwiki-genome-dependencies, gwiki or gwiki-webapp projects.

Starting the webapp

You need a Apache Tomcat Webserver (or any other servlet container) to run the webapp.
Edit the servers server.xml file and put the gwiki-webapp project in there. Here is an example configuration:

Server.xml

<?xml version="1.0" encoding="UTF-8"?>

  <Listener SSLEngine="on" className="org.apache.catalina.core.AprLifecycleListener"/>
  <Listener className="org.apache.catalina.core.JasperListener"/>
  <Listener className="org.apache.catalina.mbeans.ServerLifecycleListener"/>
  <Listener className="org.apache.catalina.mbeans.GlobalResourcesLifecycleListener"/>

  <GlobalNamingResources>

    <Resource auth="Container" description="User database that can be updated and saved"
factory="org.apache.catalina.users.MemoryUserDatabaseFactory" name="UserDatabase"
pathname="conf/tomcat-users.xml" type="org.apache.catalina.UserDatabase"/>
  </GlobalNamingResources>


  <Service name="Catalina">

    <Connector connectionTimeout="20000" port="8080" protocol="HTTP/1.1" redirectPort="8443"/>
    <Connector SSLEnabled="true" clientAuth="false" maxThreads="150" port="8443"
protocol="HTTP/1.1" scheme="https" secure="true" sslProtocol="TLS"/>

    <!-- Define an AJP 1.3 Connector on port 8009 -->
    <Connector port="8009" protocol="AJP/1.3" redirectPort="8443"/>


    <Engine defaultHost="localhost" name="Catalina">

      <Realm className="org.apache.catalina.realm.UserDatabaseRealm" resourceName="UserDatabase"/>

      <Host appBase="webapps" autoDeploy="true" name="localhost" unpackWARs="true"
xmlNamespaceAware="false" xmlValidation="false">

      <Context docBase="gwiki-webapp" path="/gwiki-webapp" reloadable="true"
 source="org.eclipse.jst.jee.server:gwiki-webapp"/></Host>
    </Engine>
  </Service>
</Server>

First steps with GWiki

Loging in

After GWiki is installed and running, you can log in as the following user.

UserPassworddescription
gwikisu gwiki You have the rights to do everything.

Please change this password as soon as you go public. On top at the rigth side you can see now the GWiki menu bar.

GWiki Menubar

There are links for editing and creating new GWiki elements like pages or attachments. In your user menu you can edit your profile, password and home area. The admin menu at the left side brings all tools and options to tune GWiki as you wish.

Creating your first GWiki page

gWikie Greate Page

To save the page simply click on "Save", to discard it "Cancel" and to watch a preview of it press "Preview". You can also do some settings like turning off e-mail notification when the page is changed.

The administration menu

This menu allows to maintain all aspects of the wiki.

User management
The user management is accessable through the link "GWiki users" in the administrator menu. There you can easily create new users or modify their attributes like password, locale settings, their own userpage or individual skin of the wiki. You can also choose user rights, which determines the access on the content of your wiki.

Import and export GWiki pages
These menu entries allow to import or export GWiki pages. If you ever change to a another GWiki installation you can take along your old pages.

Delete pages
To delete GWiki pages simply click on the "delete pages" link in the administration menu.

Global settings
To change global settings like the url and e-mail of the wiki, the default skin, language or installed wiki macros click on the "WikiConfig" Link in the administrator menu.

Control panel
The control panel allows to show all pages of the wiki in a table. There are buttons for reloading the wiki, to show changes in the css styles and for reindexing the search index. It can be found under the menu entry "WikiControl".