apache/jspwiki

Apache JSPWiki 2.12 文档

本文档基于Apache软件基金会（ASF）的许可协议授权。您可以在https://www.apache.org/licenses/LICENSE-2.0获取许可证副本。除非***要求或书面同意，否则根据许可证分发的软件按"原样"提供，不附带任何明示或暗示的担保或条件。有关权限和限制的具体规定，请参阅许可证。许可证文件可在LICENSE中找到。

什么是JSPWiki？

JSPWiki是一个用Java和JSP编写的WikiWiki系统，允许任何人参与网站协作开发。它支持所有传统wiki功能，以及通过JAAS实现的详细访问控制和安全集成，适用于搭建协作式知识共享平台。

• 更多信息请参见https://jspwiki-wiki.apache.org/

核心功能与特性

• 传统Wiki功能：支持页面创建、编辑、版本历史、内部链接等基础wiki操作
• 安全控制：提供细粒度访问控制机制，结合JAAS实现安全认证与授权
• 灵活性：通过配置文件自定义系统行为，适应不同协作场景需求
• 跨平台：基于Java技术栈，可在任何支持JSP引擎和JDK 17+的服务器运行
• 可扩展性：支持插件扩展，可集成邮件通知等附加功能

适用场景

适用于需要搭建团队知识库、项目文档库、内部协作平台的组织或个人，尤其适合具有Java Web服务器（如Apache Tomcat）管理经验的用户。

前置要求

必需条件

• JSP引擎：支持Servlet API 6.0的JSP引擎，推荐Apache Tomcat 10.1+
• 服务器环境：可运行JSP引擎的服务器
• 管理经验：具备基本Web服务器管理经验（如Apache或Tomcat配置）
• JDK：JDK 17及以上版本

可选条件

• JavaMail组件：如需使用log4j邮件通知功能，需JavaMail包及Java Activation Framework

安装与配置指南

简易安装

适用于快速部署场景，步骤如下：

1. 从https://tomcat.apache.org/安装Tomcat（或其他Servlet容器）
2. 将JSPWiki.war文件重命名为期望的URL路径名（如希望访问路径为/wiki，重命名为wiki.war，下文称此名称为<appname>）
3. 将重命名后的WAR文件放入$TOMCAT_HOME/webapps目录，启动Tomcat
4. 在浏览器访问http://<服务器地址>/<appname>/Install.jsp
5. 完成安装向导配置
6. 重启Servlet容器
7. 访问http://<服务器地址>/<appname>/即可使用

高级安装

适用于需要自定义配置的场景：

1. 在$TOMCAT_HOME/lib目录（或对应Servlet容器的类路径）创建jspwiki-custom.properties文件，用于覆盖默认配置（默认配置位于JSPWiki JAR包的ini/jspwiki.properties）

2. 常用自定义配置项：

   • jspwiki.xmlUserDatabaseFile：用户数据库文件路径
   • jspwiki.xmlGroupDatabaseFile：用户组数据库文件路径
   • jspwiki.fileSystemProvider.pageDir：页面存储目录
   • jspwiki.basicAttachmentProvider.storageDir：附件存储目录
   • log4j.appender.FileLog.File：日志文件路径

3. 将jspwiki-corepages.zip解压至目标目录，文档可在JSPWiki-doc.zip中获取

4. 重启Tomcat，访问http://<服务器地址>/MyWiki/即可

注：WEB-INF/jspwiki.policy文件用于配置Wiki访问权限策略

Docker镜像部署

获取镜像

bash
$ docker pull docker.xuanyuan.run/apache/jspwiki

运行容器

bash
$ docker run -d -p 8080:8080 --name jspwiki apache/jspwiki

容器启动后，通过http://localhost:8080/即可访问Wiki系统。高级自定义配置参见https://jspwiki-wiki.apache.org/Wiki.jsp?page=Docker。

版本升级

升级前请查阅发行版中的ReleaseNotes和UPGRADING文档，了解版本变更及迁移注意事项。

技术支持

可通过jspwiki-users邮件列表提问，详情参见https://jspwiki.apache.org/community/mailing_lists.html。请使用公共列表而非直接联系团队成员，并避免在提问中包含敏感信息。