mikoweb / joomla-rapid-composer
一个Composer插件,用于将Joomla扩展安装到您的系统中。
Requires
- composer-plugin-api: 1.0.0
README
此Composer插件将扩展安装到您的Joomla设置中。
用法
使用Joomla Startup快速开始
检出仓库
svn co http://repo.mikoweb.pl/svn/joomla-startup/trunk ./
将域名附加到web目录或创建到public_html的符号链接
ln -s web public_html
运行命令
php joomla.php joomla:install 3.3.*
定义一个包
要开始使用,请在您的composer.json文件中定义一个自定义包。您只需要您要安装的扩展的包文件。(例如,您从供应商网站下载的安装程序文件)
在Joomla安装的根目录中创建composer.json文件,并使其看起来像这样
{
"repositories": [
{
"type": "package",
"package": {
"name": "vendor/extension",
"type": "joomlatools-installer",
"version": "1.0.0",
"dist": {
"url": "file:////Users/johndoe/Downloads/com_extension.1.0.0.tar.gz",
"type": "tar"
},
"require": {
"joomlatools/installer": "*"
}
}
}
],
"require": {
"vendor/extension": "1.0.0"
}
}
使用此JSON文件,我们已定义了自己的自定义包。请注意以下设置
- 必须将
type设置为joomlatools-installer - 确保
url指令指向安装包的位置。
执行composer install将现在获取mikoweb/joomla-rapid-composer插件,并使用它将包安装到您的Joomla安装中。
有关为不支持Composer的项目创建这些自定义包的更多信息,请参阅Composer文档。
创建自定义包
要利用Composer的所有功能,例如升级到较新版本,您最好使用扩展的源代码创建一个包。
包定义应包含以下基本信息,以便将其安装到Joomla中
{
"name": "vendor/my-extension",
"require": {
"mikoweb/joomla-rapid-composer": "*"
}
}
如果您想直接从Github或其他VCS提供您的扩展,请确保您的repo中的文件布局类似于安装包。
您现在可以在Packagist上发布您的扩展,或使用您自己的Satis仓库自行提供。
有关创建自定义包的更多信息,请参阅Composer文档。
更改用户
安装程序在运行时将名为root的用户注入到Joomla应用程序中,以确保安装程序脚本具有执行所需的权限。
如果出于某种原因需要更改此模拟用户的信息,可以通过在composer.json的config部分添加一个joomla块来覆盖它们。示例
{
"config": {
"joomla": {
"basedir": "joomla",
"username": "johndoe",
"name": "John Doe",
"email": "john@doe.com"
}
}
}
调试
遇到问题?您可以增加Composer的详细设置(-v|vv|vvv)以收集更多信息。增加Composer的详细设置还将启用Joomla的日志消息。
要求
- Composer
- Joomla版本2.5及以上。
贡献
我们欢迎任何贡献,无论是有关错误、语法,还是仅仅是一个建议或改进。我们要求任何贡献遵循一些简单的指南,以便得到适当的接受。
我们遵循从开发到发布的 GitFlow 分支模型。如果您不熟悉它,网上有许多指南和教程可以帮助您了解。
在提交拉取请求之前,您需要了解以下几点
- 所有更改都需要在
develop分支上完成。然而,我们非常欢迎并且强烈建议您从develop分支开始创建一个新的功能分支,并在该新分支中进行更改。这样,我们就可以在将其合并到develop之前测试您的功能分支。 - 我们不会考虑直接提交到
master分支的拉取请求。
贡献者
请参阅 贡献者列表。
许可
joomlatools/installer 插件是免费的开源软件,受 GPLv3 许可协议 许可。