Shaarli项目配置详解：从基础设置到高级功能

Shaarli项目配置详解：从基础设置到高级功能

Shaarli 项目地址: https://gitcode.com/gh_mirrors/sh/Shaarli

什么是Shaarli配置系统

Shaarli作为一个轻量级的书签管理工具，其核心功能通过配置文件实现高度定制化。安装完成后，系统会自动生成data/config.json.php配置文件，这个文件采用JSON格式存储所有设置项，并通过PHP注释包裹确保安全性。

配置文件基础解析

配置文件采用分层结构设计，主要包含以下几个核心模块：

1. 凭证信息(Credentials)：存储用户登录名、密码哈希和盐值
2. 安全设置(Security)：包括登录保护、IP封禁等安全相关配置
3. 资源路径(Resources)：定义各类数据文件的存储位置
4. 常规设置(General)：控制实例的基础行为和外观
5. 隐私设置(Privacy)：管理书签的可见性和访问控制
6. 插件配置(Plugins)：启用和配置各类扩展功能

关键配置项详解

1. 安全配置最佳实践

"security": {
    "ban_after": 4,
    "session_protection_disabled": false,
    "ban_duration": 1800,
    "trusted_proxies": ["1.2.3.4"],
    "allowed_protocols": ["ftp", "ftps", "magnet"]
}

• ban_after：建议设置为3-5次，平衡安全性与用户体验
• session_protection_disabled：除非在负载均衡环境下，否则应保持false
• trusted_proxies：当Shaarli部署在反向代理后时需正确配置
• allowed_protocols：根据实际需求添加协议，避免安全隐患

2. 内容格式化选项

Shaarli支持三种内容渲染引擎：

1. default：基础格式化，支持自动链接和换行
2. markdown：标准Markdown语法支持
3. markdownExtra：扩展Markdown功能

"formatter": "markdown",
"formatter_settings": {
    "default": {
        "autolink": true
    }
}

3. 多语言支持配置

"translation": {
    "language": "auto",
    "mode": "php",
    "extensions": {
        "demo": "plugins/demo_plugin/languages/"
    }
}

• language：支持auto(自动检测)、en、fr等选项
• mode：php实现兼容性好，gettext性能更佳但需要额外组件
• extensions：可为插件添加独立的多语言支持

实用功能配置技巧

1. 缩略图生成配置

"thumbnails": {
    "width": 125,
    "height": 90,
    "mode": "common"
}

• mode可选：
  • all：为所有链接生成缩略图
  • common：仅为主流网站生成(推荐)
  • none：禁用缩略图

2. RSS订阅优化

"feed": {
    "rss_permalinks": true,
    "show_atom": false
}

设置rss_permalinks为true可确保RSS中的链接指向Shaarli的永久链接而非原始URL。

3. 隐私控制策略

"privacy": {
    "default_private_links": true,
    "hide_public_links": false,
    "force_login": false,
    "hide_timestamps": false
}

通过这些选项可以灵活控制：

• 新书签的默认可见性
• 未登录用户的访问权限
• 时间戳的显示方式

配置管理建议

1. 优先使用Web界面：通过Tools菜单修改配置最安全
2. 备份配置文件：修改前备份config.json.php
3. 分阶段测试：复杂修改应逐步验证
4. 关注文件权限：确保Web服务器有读写权限但其他用户不可写

常见问题解决方案

Q：修改配置后页面显示异常？ A：检查JSON格式是否正确，特别是逗号和引号的使用。

Q：如何恢复默认配置？ A：删除config.json.php后重新访问，系统会生成新文件。

Q：插件不生效怎么办？ A：确认插件名已添加到enabled_plugins数组，且相关路径配置正确。

通过合理配置，Shaarli可以完美适应从个人使用到团队协作的各种场景，建议根据实际需求逐步调整各参数，找到最适合的使用方式。

Shaarli 项目地址: https://gitcode.com/gh_mirrors/sh/Shaarli