From a05b75b30b0db9d07bc09100a368fec8431f8495 Mon Sep 17 00:00:00 2001 From: printempw Date: Fri, 9 Feb 2018 16:05:46 +0800 Subject: [PATCH] Update README Also separate many README sections to individual wiki articles. --- README.md | 93 ++++++++++++++++++++----------------------------------- 1 file changed, 34 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index bf301dfa..afb41c53 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ - 简体中文 -- [English](https://github.com/printempw/blessing-skin-server/blob/master/README-en.md) +- [English](https://github.com/printempw/blessing-skin-server/blob/master/README_EN.md)

@@ -14,57 +14,59 @@ 优雅的开源 Minecraft 皮肤站，现在，回应您的等待。 -Blessing Skin Server 是一款能让您上传、管理和分享您的 Minecraft 皮肤和披风的 Web 应用程序。与修改游戏材质包不同的是，所有人都能在游戏中看到各自的皮肤和披风（当然，前提是玩家们要使用同一个皮肤站）。 +Blessing Skin 是一款能让您上传、管理和分享您的 Minecraft 皮肤和披风的 Web 应用程序。与修改游戏材质包不同的是，所有人都能在游戏中看到各自的皮肤和披风（当然，前提是玩家们要使用同一个皮肤站）。 -Blessing Skin Server 是一个开源的 PHP 项目，这意味着您可以自由地在您的服务器上部署它。这里有一个[演示站点](http://skin.prinzeugen.net/)。 +Blessing Skin 是一个开源的 PHP 项目，这意味着您可以自由地在您的服务器上部署它。这里有一个 [演示站点](http://skin.prinzeugen.net/)。 特性 ----------- +- 完整实现了一个皮肤站该有的功能 - 支持单用户多个角色 - 通过皮肤库来分享您的皮肤和披风！ - 易于使用 - 可视化的用户、角色、材质管理页面 - 详细的站点配置页面 + - 多处 UI/UX 优化只为更好的用户体验 - 安全 - - 只保存 Hash 后的用户密码 - - 注册可要求 Email 验证（以插件的形式实现） + - 支持多种安全密码 Hash 算法 + - 注册可要求 Email 验证（插件） - 防止恶意请求的积分系统 -- 可扩展 +- 强大的可扩展性 - 多种多样的插件 - - 支持与 Authme/CrazyLogin/Discuz 的数据对接 + - 支持与 Authme/Discuz 等程序的用户数据对接 + - 支持自定义 Yggdrasil API 外置登录系统 环境要求 ----------- -Blessing Skin Server 对您的服务器有一定的要求。在大多数情况下，下列所需的 PHP 扩展已经开启。 +Blessing Skin 对您的服务器有一定的要求。_在大多数情况下，下列所需的 PHP 扩展已经开启。_ - 一台支持 URL 重写的主机，Nginx、Apache 或 IIS -- **PHP >= 5.5.9** （如果服务器不支持，你可以用 v2.x 版本） -- PHP 的 OpenSSL 扩展 -- PHP 的 PDO 扩展 -- PHP 的 Mbstring 扩展 -- PHP 的 Tokenizer 扩展 -- PHP 的 GD 扩展（用于生成验证码） +- **PHP >= 5.5.9** [（服务器不支持？）](https://github.com/printempw/blessing-skin-server/wiki/%E7%89%88%E6%9C%AC%E8%AF%B4%E6%98%8E) +- 安装并启用如下 PHP 扩展： + - OpenSSL + - PDO + - Mbstring + - Tokenizer + - GD + +如果你使用的是 PHP 7.2，请先阅读 [Wiki - 在 PHP 7.2 上运行](https://github.com/printempw/blessing-skin-server/wiki/%E5%9C%A8-PHP-7.2-%E4%B8%8A%E8%BF%90%E8%A1%8C)。 快速使用 ----------- -1. 下载皮肤站的 [最新版本](https://github.com/printempw/blessing-skin-server/releases)，并解压到你想要安装到的位置。 -2. 将 `.env.example` 重命名为 `.env` 并**配置你的数据库信息**。（Windows 用户请重命名为 `.env.`，最后的小数点会自动消失） -3. Nginx 用户请添加 [Rewrite 规则](#%E6%9C%8D%E5%8A%A1%E5%99%A8%E9%85%8D%E7%BD%AE) 到你的 Nginx 的配置文件中。 -4. 在浏览器中打开 `http://your-domain.com/setup` 。如果出现 404，请检查 Rewrite 规则是否正确并有效。 -5. 按照提示执行安装程序 +请参阅 [Wiki - 快速安装向导](https://github.com/printempw/blessing-skin-server/wiki/%E5%BF%AB%E9%80%9F%E5%AE%89%E8%A3%85%E5%90%91%E5%AF%BC)。 + +![screenshot](https://img.blessing.studio/images/2017/07/29/2017-06-16_15.54.16.png) 插件系统 ------------ -Blessing Skin Server 提供了强大的插件系统，您可以通过添加多种多样的插件来为您的皮肤站添加功能。 +Blessing Skin 提供了强大的插件系统，您可以通过添加多种多样的插件来为您的皮肤站添加功能。 -- [官方插件列表](https://github.com/printempw/blessing-skin-server/wiki/%E5%AE%98%E6%96%B9%E6%8F%92%E4%BB%B6%E5%88%97%E8%A1%A8) -- [官方示例插件](https://coding.net/u/printempw/p/blessing-skin-plugins/git/tree/master/example-plugin) -- [插件开发文档](https://github.com/g-plane/blessing-skin-plugin-docs) +详情请参阅 [Wiki - 插件系统介绍](https://github.com/printempw/blessing-skin-server/wiki/%E6%8F%92%E4%BB%B6%E7%B3%BB%E7%BB%9F%E4%BB%8B%E7%BB%8D)。 自行构建 ------------ -如果你想为此项目作贡献，你应该先用 Git 上的代码部署。 +如果你想为此项目作贡献，或者抢先尝试未发布的新功能，你应该先用 Git 上的代码部署。 **不推荐不熟悉 shell 操作以及不想折腾的用户使用。** @@ -79,53 +81,26 @@ $ yarn install 运行自动化测试（可跳过）： ```bash -$ yarn test # JavaScript -$ ./vendor/bin/phpunit # PHP +$ yarn test +$ ./vendor/bin/phpunit ``` -构建代码！ +构建前端代码！ ```bash $ yarn run build ``` -恭喜，构建完成！接下来请参考「快速使用」的第二点进行后续安装。 +接下来请参考「快速安装向导」进行后续安装。 -服务器配置 +问题报告 ------------ -如果你使用 Apache 或者 IIS 作为 web 服务器（大部分的虚拟主机），那么恭喜你，我已经帮你把重写规则写好啦，开箱即用，无需任何配置~ - -如果你使用 Nginx，请在你的 nginx.conf 中加入如下规则**（重要）**： - -``` -location / { - try_files $uri $uri/ /index.php?$query_string; -} - -# Protect .env file -location ~ /\.env { - deny all; -} -``` - -Mod 配置 ------------- -请前往 [Wiki - Mod Configuration](https://github.com/printempw/blessing-skin-server/wiki/Mod-Configuration) - -![screenshot](https://img.blessing.studio/images/2017/07/29/2017-06-16_15.54.16.png) - -FAQ ------------- -阅读 [Wiki - FAQ](https://github.com/printempw/blessing-skin-server/wiki/FAQ) 并在报告问题之前再次确认 FAQ 中确实没有提到你的情况。 - -Bug 报告 ------------- -请带上你的日志文件（位于 `storage/logs/laravel.log`）联系我。你还应该提供错误发生时服务器的一些信息。Bug 将会被尽快解决。 +请参阅 [Wiki - 报告问题的正确姿势](https://github.com/printempw/blessing-skin-server/wiki/%E6%8A%A5%E5%91%8A%E9%97%AE%E9%A2%98%E7%9A%84%E6%AD%A3%E7%A1%AE%E5%A7%BF%E5%8A%BF)。 版权 ------------ -Blessing Skin Server 程序是基于 GNU General Public License v3.0 开放源代码的自由软件，你可以遵照 GPLv3 协议来修改和重新发布这一程序。 +Blessing Skin 程序是基于 GNU General Public License v3.0 开放源代码的自由软件，你可以遵照 GPLv3 协议来修改和重新发布这一程序。 **例外情况**：任何为 Blessing Skin 皮肤站程序开发、调用了 Blessing Skin 插件 API 的插件程序，在未使用 Blessing Skin 程序源代码的情况下，无须采用 GPLv3 协议，也不强制要求开放插件源代码。 -程序原作者为 [@printempw](https://prinzeugen.net/)，转载请注明。 +程序原作者为 [@printempw](https://blessing.studio/)，转载请注明。