Skip to content

Latest commit

 

History

History
140 lines (98 loc) · 7.75 KB

README.md

File metadata and controls

140 lines (98 loc) · 7.75 KB
Raw

OpenNav

OpenNav

⭐ 开放、自由的个人网络收藏夹 ⭐

pipeline status Latest Release

🔗 GitLab (Homepage) | 🔗 GitHub

✨ 特性

  • 🔎 前端实时全文搜索
  • 📁 两级分类标签设计
  • 🌲 多前端主题一键切换
  • 🖥️ 直观设计的控制台面板
  • ⏱️ 支持高安全性时基验证登录
  • ⭐ 一键导入 Chrome / Edge 收藏夹
  • 🛠 全量操作 API 化，便捷二次开发
  • ☁️ 轻量化开发，全接口注释
  • 🔐 全局完整鉴权流程及渗透防护

✔️ 要求

  • PHP 8.0 或更高版本
  • PHP 插件
    • PHP pdo_sqlite 以使用 SQLite 数据库
    • PHP curl 以获取在线内容（如自动更新、主题）
    • PHP mbstring 以生成文字网站图标及配置时基验证
    • PHP intl 以获取准确的根域名信息
    • PHP fileinfo 以在线获取网站图标（可选）
    • PHP file_uploads 启用了上传机制以导入 Chrome / Edge 收藏夹
    • PHP upload_max_filesize 与最大文件上传大小匹配，建议至少为 8 MiB
  • 支持所有 现代浏览器（极为有限的 Internet Explorer 支持）

⚙️ 从发布版本部署（推荐）

  1. 前往本项目发布页 GitLab | GitHub 获取最新编译版本软件包，包名为 OpenNav-compiled.zip

  2. 将软件包上传至服务器站点目录中，并解压

  3. 设置站点运行目录为解压出的 Public 目录

  4. 访问你的网站，如果一切正常，将会显示 安装 OpenNav 页面，在安装时系统会自动进行运行环境检查，如出现错误，请仔细阅读报错提示，如遇到无法解决的错误，可提交 Issue 寻求帮助

  5. 配置周期任务

    • 方式一：添加到系统 crontab

      请将 /path/to/your/opennavroot 修改为您的 OpenNav 目录

      30 2 * * * php /path/to/your/opennavroot/Cron/Cron.php

    • 方式二：使用工具周期性（建议为 24 小时）访问以下地址

      请将 opennav.yourdomain.com 修改为您的域名

      https://opennav.yourdomain.com/index.php?c=Cron

⚙️ 从源代码部署

  1. 确保您的服务器已安装 NodeJS、Composer

  2. 执行以下命令拉取源代码

    git clone --depth=1 https://gitlab.soraharu.com/XiaoXi/OpenNav.git

# 或者，也可以从 GitHub 仓库拉取

git clone --depth=1 https://github.com/yanranxiaoxi/OpenNav.git

  3. 进入源代码目录并编译、安装、获取默认主题

    cd ./OpenNav/
npm run ins

  4. 设置站点运行目录为项目文件夹内的 Public 目录

  5. 继续执行 从发布版本部署 的第 4 步骤

Warning

从源代码部署仅建议用于开发环境，本项目当前处于快速迭代开发阶段，未经过完整验证的源代码可能会出现较多未知错误，请在遇到无法解决的错误时首先尝试使用 git reset --hard upstream/main && git clean -fdx && git pull 拉取最新版本源代码，如确认处在最新版本，可开启 Issue 并附上您的复现过程，开发者将会尽快予以回应。

🛠 参与开发

  1. 确保您的计算机已安装 NodeJS、Composer

  2. Fork 本项目仓库到您的 GitHub、GitLab 或其他受支持的 Git 托管平台

  3. 克隆您的 Fork 仓库到本地

    请按实际情况修改 whereyourgit.com 和 yourusername

    git clone --depth=3 https://whereyourgit.com/yourusername/OpenNav.git

  4. 进入项目目录并编译、安装、获取默认主题

    cd ./OpenNav/
npm run ins:dev

  5. 使用合适的 IDE 打开项目目录。本项目推荐使用 Visual Studio Code + PHP Intelephense + PHP Server + Prettier + EditorConfig 进行开发，可以获得较为出色的代码提示效果

  6. （可选）如您使用以上推荐环境进行开发，可配置 .vscode/settings.json 为以下内容，开启代码自动格式化

    {
	"editor.formatOnSave": true,
	"editor.defaultFormatter": "esbenp.prettier-vscode"
}

  7. 进行您的开发

  8. 提交 Commit 前，请使用 npm run fix 格式化代码

  9. 发起 Pull Request 并阐明您所做出的更改

  10. 感谢您的贡献！~

📜 开源许可

本项目支持个人及非商业社会团体 免费使用所有主线功能（仅额外的主题、去除前端版权标识、插入付费广告等商业性质功能需要授权激活使用）。

个人（支持个人商用）及非商业社会团体可支付 [99 CNY] 获取永久使用授权。

商业用途企业需支付 [299 CNY] 以获取永久使用授权。

主线功能基于 Mozilla Public License Version 2.0 许可进行开源，商业性质功能具有 专属许可协议。

所有使用者、贡献者仍需遵循以下附加条款：

  1. 未获取永久使用授权的个人、团体、企业 不属于 许可的开源对象；
  2. 对本项目进行修改、重构、衍生开发等再演绎过程时不可去除任何授权限制代码；
  3. 本项目仅为通用个人网络收藏夹用途，其功能类似于浏览器的同步收藏夹，项目所有者及贡献者均不提供任何网络服务用于托管本项目的副本，所有未合并入主分支的代码均不属于本项目，所有用户自部署实例上的内容均与本项目无任何关联；
  4. 处于任何国家、地区的任何个人、团体、企业在使用本项目及其任何衍生功能时，均需遵守中华人民共和国现行法律之约束，不将本项目的任何副本用于违法用途，所有不当用途所造成的合规风险均由使用者承担；
  5. 所有参与本项目的贡献者需了解，如因合规原因需要更改本项目许可的附加条款甚至完整许可协议，项目所有者承诺将会发送电子邮件通知，并视为贡献者无条件同意此更改，无论是否接收到该电子邮件；
  6. 参与贡献的开发者均可以申请获取使用授权，但仍受上述协议限制，如不接受以上许可协议及附加条件，请不要使用本项目或参与本项目的贡献。

以上附加条款仅为本项目所有者面对所在地域当前开源环境的无奈之举，请大家见谅，望有朝一日能安心去除以上附件条款，而无需有任何「开源负担」。