常见问题

sward

sward - 文档

在日常工作中，高效的知识沉淀与协作是团队效能的核心。我们通常使用Confluence、语鹊等工具来构建团队知识库。鉴于Confluence Server已临近其生命周期的终点，为保障团队知识管理的连续性与安全性，推荐一款优秀的开源平替方案-sward。

sward，一款国产的且免费开源的知识管理工具，包含知识库管理、目录管理、文档管理、markdown管理、文档的评审与版本维护等模块。产品页面简洁大方，功能完备且体验流畅。

支持在线创建富文本文档、markdown、上传预览本地文件；

内置丰富的文档模版，如会议记录类、周报日志类、产品设计类、技术研发类、测试管理类等。

支持系统级别、知识库级别、目录与文档级别的权限控制。

支持日志审计以便于追溯历史操作；

支持知识库与文档的归档、放入回收站。

操作直观易用，页面设计简洁大方。

免费开放源代码，通过协作和共享的方式推动项目的发展

关于Sward

1) 点击企业版特性，查看企业版所提供的功能列表

2) 点击订阅，跳转到注册登录页面，登录成功后进入

2. 登录官网，点击个人中心->订阅管理，页面跳转到订阅管理页面 

1) 已订阅：显示您已经订阅公司的产品

2) 推荐订阅：显示公司所有产品

1). 购买时长：可以选择1到5年或者永久，每种时长有不同程度优惠。

2). 购买数量：代表订阅后的系统可以允许登录的用户数量。

5. 支持成功后会在订阅管理-已订阅中查看到一条订阅信息

1) 点击Licence,在弹出的窗口中输入部署sward机器的MAC地址，确定后Licence文件会自动下载。

2) 订阅人数：就是确认订单页面的购买数量，代表允许登录系统的人数。若需要满足更多人员的登录，可以点击扩容购买用户数量。

3) 结束时间：当前license到期时间。license到期后，可以点击续订，继续使用sward企业版。

5. 导入license：回到sward系统首页，依次点击系统设置->应用->版本与许可证->导入license。

1) 点击导入Licence,选择上一步下载好的Licence文件

2) 用户数：显示Licence的购买数量，也就是当前系统可以登录的用户数量

3) 生效日期：显示购买Licence的日期

4) 过期时间：显示当前Licence的过期时间。Licence过期后，企业版特性不可用，但不影响已存在数据和社区版功能的使用。

社区版和企业版的区别

扫描二维码，加入我们的技术交流群，参与互动交流

扫描二维码，添加客服，享受专业的产品售前咨询服务

联系我们

产品介绍

启动完成后，控制台会显示应用访问地址，在浏览器输入http://ip:9600访问系统，默认使用本地登录模式，默认登录帐号密码为admin/123456

企业微信、钉钉多种登录方式，及支持通过soular统一帐号与门户中心使用统一登陆，更多信息可参见相关文档。

sward 私有部署版本可以对数据库，启动端口、数据存放地址、dcs（缓存配置）、dfs(附件存储）等参数进行配置

：默认在/opt/tiklab-sward/conf/application.yaml

应用启动端口可自定义，默认为9600，可以修改为其他端口；

数据库需要在jdbc 和 postgresql 两个部分修改，可以修改数据库地址与端口，账号与密码要改成相应的，数据库端口必须一致

dfs 是文件管理配置， 只能修改端口

dcs 是缓存配置，只能修改端口。

统一登录，即使用统一使用Soular的用户，部门等，这样配置可以让一个用户同时使用多个应用。需要安装Soular，具体安装见

Linux安装配置

Docker镜像启动完毕之后，如需要将Docker镜像中的数据目录挂载到主机，需要执行如下命令

默认在镜像文件内/usr/local/apps/tiklab-sward/conf/application.yaml

进入镜像文件内/usr/loacl/tiklab-sward/bin目录下，执行update.sh 脚本

Docker安装配置

C:\Program Files (x86)\sward\conf\application.yaml

Windows安装配置

启动完成后，控制台会显示应用访问地址，在浏览器输入http://ip:9600访问系统，默认使用本地登录模式，默认登录帐号密码为admin/123456。

Mac安装配置

软件研发是个复杂的过程，企业需要协调管理者、产品、研发、测试、运维等多个角色及部门的目标一致和高效协同，更需要进行合理的资源分派、把控项目进度、控制风险、保障产品交付质量。

kanass 专注于企业级研发管理工具及解决方案，结合 「管理」+「协作」设计理念 ，旗下产品矩阵贯穿产品研发全生命周期，促进产品、研发、测试、运维等产品研发过程中各角色的良好协作；同时立足国情，在自上而下的团队资源管理、风险控制、效能度量等管理场景做了加深。

从创业公司到中大型企业，kanass 提供更专业的团队协作与项目管理工具，助力企业更好更快发布产品。

贯穿 tiklab 产品矩阵，适配 需求管理、任务管理、缺陷管理、迭代管理等研发项目管理全场景 ，提供敏捷、瀑布、通用任务协同等多种项目模板，开箱即用。

适用角色：项目经理、产品经理、研发工程师、测试工程师

    为研发团队中每个角色构建，适配需求管理、任务管理、缺陷管理、迭代管理等全部场景

    支持产品经理、研发工程师、测试工程师、项目经理等多职能共同协作

    支持研发团队及时更新任务进度，将代码与持续集成结果同步至一处

    与 tilab 各个产品数据互通，改善工作流

安装指南

添加成功后，会自动进入知识库。点击

，可以查看到上一步添加的知识库。

知识库添加成功后，可以为知识库添加成员。首先在系统层面添加用户

。系统内置管理员用户，无法删除。

在弹出窗口中为用户修改角色，可以选择普通用户或是admin。

注：两种权限的区别：admin可以删除知识库，普通用户不能删除知识库

添加知识库

知识库创建成功后，可以在知识库里添加目录、文档和上传文件。

，可以继续为目录添加二层目录。以此类推，目录支持添加多层级。

按钮，可以对其进行操作，包括：重命名、删除、移动、分享、移动到回收站

添加目录

，系统会创建出一个名字为“未命名文档”的文档。修改内容和文档名称后点击

1）直接点击“未命名文档（1）”为文档重命名；

2）直接点击“输入内容”区域，直接创作文档；

3）可以点击系统提供的默认模板，包括：周报模块、工作周报、代办工作清单、项目规划和执行、项目运营计划。

2）在输入区域输入内容，展示区域会同步显示结果。

1）全面支持各种类型文件上传，且文件可以随时下载到本地

3）针对word、pdf、Excel文件，提供在线预览功能

，可以对其进行操作，包括：重命名、删除、移动、分享、移动到回收站

添加文档

删除知识库包含两个功能，移入回收站和删除知识库

1）删除知识库会直接把知识库、知识库内的文档、目录全部删除

2）为防止误删，点击删除时，会需要填写当前知识库的名称

知识库设置

快速入门

在浏览器地址栏输入网址，默认进入系统首页；或者点击

首页上部分是常用知识库，按照点击时间排序；点击卡片，就可以进入知识库；

首页

查询知识库

查看知识库

概况

知识库信息

成员

权限

消息通知方案

知识库

查询目录

删除目录

查看目录

修改目录

添加Markdown

上传本地文件

查看文档

编辑文档

编辑Markdown

删除文档

文档

部门

用户

用户组

用户目录

用户与权限

消息发送方式

消息

地址配置

操作日志

备份与恢复

安全

版本与许可证

应用与访问权限

应用

设置

使用指南

最佳实践

系统全面支持各种附件的上传，上传后文件可以再次下载到本地，对部分文件支持在线预览

v1.0.8更新日志

sward是一款国产开源企业级知识管理工具，包含知识库管理、文档管理、文档协作、文档分享等模块，支持普通文档、markdown等格式，产品简洁易用、开源免费。本周sward发布V1.1.1版本，增加了confluence数据导入、文档版本和全文搜索功能，并优化了页面展示效果。

登录sward系统，系统设置->集成与开放->confluence导入，点击导入confluence数据并上传confluence的zip包。按照页面提示依次点击解析文件和导入文件，导入日志中出现导入完成，标志confluence数据已经成功导入sward。

导入成功后，进入知识库页面，可以看到导入的confluence数据。confluence中的空间在sward中以知识库的形式展示，页面以文档的形式展示。

进入知识库->添加文档，文档保存成功并退出后，点击文档的更多按钮->添加版本->填写版本名称->确定。当前的版本保存成功。再次编辑文档后，按照同样的步骤可以继续保存版本。

点击文档更多按钮->查看版本。点击任意的版本名称，可以展示出当前版本所保存的内容。

当知识库中文档过多时，可以使用关键字搜索。点击搜索->输入关键字->查看搜索结果。搜索结果中会列出文档的名称和所在的知识库。便于用户查找文档。

sward V1.1.1版本发布，支持confluence导入与文档版本管理

sward是一款国产开源企业级知识管理工具，包含知识库管理、文档管理、文档协作、文档分享等模块，支持普通文档、markdown等格式，产品简洁易用、开源免费。本周sward发布V1.1.4版本，增加了文档审批和文档导出为word的功能，并优化了附件与confluence的相关功能。

若希望文档只有在被审批通过后才能被其他人查看，可以为文档开启审批功能

进入知识库，依次点击知识库设置->评审->开启

进入知识库->文档->文档的更多按钮->提交审批，选择需要审批当前文档的人员。

文档在提交审批，且未完成审批流程之前，系统其他人员对文档不可见。

审批人员登录系统后，进入知识库->审批，可以看到待自己审批的文档列表，点击文档名称预览内容，点击待评审->通过，审批完成。此时文档可以被其他人查看。

进入知识库->文档->文档更多按钮->导出word。文档会以word的格式下载到本地。

sward V1.1.4版本发布，支持文档审批及文档导出

sward是一款国产开源企业级知识管理工具，包含知识库管理、文档管理、文档协作、文档分享等模块，支持普通文档、markdown等格式，产品简洁易用、开源免费。本周sward发布V1.1.5版本，支持Mysql数据库及ubuntu系统安装包，并优化了富文本表格样式、富文本列表键盘事件处理。

sward安装成功后，会默认使用内置数据库。此版本开始支持连接外部的Mysql数据库

连接Mysql数据库，并创建一个数据库

打开sward安装目录下的yaml文件，默认安装路径为：C:\Program Files (x86)\sward\conf\application.yaml。修改driverClassName为com.mysql.cj.jdbc.Driver，url为新创建的DB地址，并填写具备登录数据库权限的username和password即可。

配置文件修改后，需要重启sward服务，配置才能生效。重启成功后打开sward地址，此时正在数据库中建表，需要等待几分钟