Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 1.72 KB

installation.md

File metadata and controls

52 lines (37 loc) · 1.72 KB

Installation

Gitiwiki is a PHP application, using the framework Jelix, and the Glip library to read the content of a git repository.

WARNING: You will probably think that the installation is a bit complicated for a non-developer, but don't worry! For the moment, GitiWiki targets only developers who want to contribute to the project. The first release will contain of course a wizard which will simplify everything!

requirements

You should have installed:

  • a web server (Apache or Nginx),
  • PHP 5.3 minimum
  • Git

No database is required.

installing the app

Here are steps:

  1. checkout the source code with git clone
  2. put "write" rights for your web server on these directories
  • temp/gitiwiki
  • gitiwiki/var/log/
  • gitiwiki/var/books/
  1. configure a virtual host with gitiwiki/www as a document root
  2. configure your virtual host with an alias /jelix/ to lib/jelix-www
  3. in gitiwiki/var/config, copy localconfig.ini.php.dist to localconfig.ini.php and profiles.ini.php.dist to profiles.ini.php
  4. open a console, go into gitiwiki/install, and launch php installer.php

In next instructions, we assume that the domain name of your virtual host is localhost.

Gitiwiki is almost ready. It needs now a Git repository.

  1. in the console, go into gitiwiki/var/repositories
  2. clone here a git repository containing files you want to display with gitiwiki
  3. or create a new repository: git init default

And that's all.

If you type http://localhost/index.php/wiki/default/, you should see a page with a "hello world" ;-)

If you want to install gitiwiki to launch its tests and/or to contribute to the project, see the Contributing.md file at the root of the sources.