WiGit 技术文档

1. 安装指南

首先，请确保您的服务器满足以下基本要求：

• Web服务器
• PHP4
• Git

以下是详细的安装步骤：

1. 将WiGit目录放置到您的web服务器能够访问的位置。
2. 确保存在一个名为data的子目录，并且该目录能够被web服务器写入。
3. 将config.php.sample复制为config.php，并根据您的本地设置编辑该文件。
4. 访问WiGit的URL，您应该会从编辑主页开始。

对于URL重写，请根据您的web服务器进行配置。以下是针对Apache和lighttpd的示例配置：

• 对于Apache，在WiGit安装目录的.htaccess文件中添加以下内容：

  <IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteBase /wigit/
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteRule (.*) /wigit/index.php?r=/$1 [L]
  </IfModule>
  

• 对于lighttpd，在您的配置文件中添加以下内容：

  url.rewrite-once = (
      "^/wigit/themes/(.*)" => "$0",
      "^/wigit(.*)" => "/wigit/index.php?r=$1",
  )
  

请注意将/wigit替换为您自己的基础URL。

2. 项目的使用说明

WiGit是一款使用PHP编写的简易Wiki系统，其使用Git作为后端来跟踪变更。以下是如何使用WiGit的基本指南：

• 通过浏览器访问WiGit的URL。
• 如果您配置了用户认证，系统将提示您输入用户名和密码。
• 一旦进入系统，您可以编辑页面，使用Textile语法进行文本格式化。
• WiGit支持语法高亮、版本历史查看等基本功能。

3. 项目API使用文档

WiGit没有提供专门的API接口。它主要通过Web界面进行操作，用户可以通过HTTP请求来编辑和查看页面。

4. 项目安装方式

WiGit的安装方式已在“安装指南”一节中详细说明。简要概括，安装过程包括：

• 将WiGit文件上传到服务器。
• 设置相关目录权限。
• 配置config.php文件。
• 根据需要配置URL重写规则。
• 对于用户支持，配置web服务器的认证机制。例如，对于Apache，在.htaccess中配置基本认证，而对于lighttpd，则需要在配置文件中设置auth相关参数。

请仔细遵循上述步骤以成功安装WiGit。