Files
RootPanel/README.md
2014-09-30 14:51:08 +08:00

70 lines
2.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# RootPanel
## 简介
RootPanel 是一个高度插件化的,基于 Linux 的虚拟服务销售平台,目标是成为虚拟主机界的 WordPress.
它的核心功能包括用户和计费系统工单系统管理员面板其余具体的功能均以插件实现RootPanel 支持的典型服务有:
* Linux 虚拟主机(Nginx, PHP, MySQL, MongoDB)
即最传统的,将一台 Linux 服务器划分给多个用户的方式。
示例站点:<http://us1.rpvhost.net>
* ShadowSocks 代理服务
按实际使用流量实时结算的 ShadowSocks 代理。
示例站点:<http://greenshadow.net>
* 朋友合租(开发中)
* Xen VPS(开发中)
## 安装和使用
* 开发版本:`git clone https://github.com/jysperm/RootPanel.git`
* 稳定版本:`npm install -g rootpanel`
* Vagrant: `https://vagrantcloud.com/jysperm/boxes/rootpanel`
详细安装说明:[INSTALL.md](https://github.com/jysperm/RootPanel/blob/master/INSTALL.md)
## 配置文件示例
请从 `sample` 中选择一个配置文件复制到根目录,重命名为 `config.coffee`:
core.config.coffee # 仅核心模块
shadowsocks.config.coffee # ShadowSocks 代理服务
full.config.coffee # 全功能虚拟主机
php-vhost.config.coffee # PHP/MySQL 虚拟主机
node-vhost.config.coffee # Node.js/Python/Golang 虚拟主机
share-vps.config.coffee # 朋友合租
static.config.coffee # 静态文件托管
git.config.coffee # Git 托管
xen.config.coffee # Xen VPS
## 技术构成
* 前端Bootstrap(3), jQuery, Jade, Less
* 后端Express, Coffee
* 数据库MongoDB(2.4), Redis
* 操作系统支持Ubuntu 14.04 amd64
## 开发情况:
* [ChangeLog](https://github.com/jysperm/RootPanel/blob/master/CHANGELOG.md)
* [Releases](https://github.com/jysperm/RootPanel/releases)
* [TODO List](https://github.com/jysperm/RootPanel/labels/TODO)
贡献列表(v0.7.1):
* jysperm 7542 lines 98.6%
* yudong 48 lines 0.6%
* Akiyori 42 lines 0.5%
* Tianhao Xiao 17 lines 0.2%
贡献须知:当你向 RootPanel 贡献代码时,即代表你同意授予 RootPanel 维护团队永久的,不可撤回的代码使用权,包括但不限于出售计划中的商业授权;
在你首次向 RootPanel 贡献代码时,我们还会人工向你确认一次上述协议。
## 许可协议
* 开源授权:[AGPLv3](https://github.com/jysperm/RootPanel/blob/master/LICENSE) | [CC-SA](http://creativecommons.org/licenses/sa/1.0/) (文档) | Public Domain (配置文件和示例)
* 商业授权(计划中)
* 有关授权的 [FAQ](https://github.com/jysperm/RootPanel/blob/develop/FAQ.md#%E6%8E%88%E6%9D%83)