getolympus/olympus

Olympus 框架,一个简单、易于使用且功能强大的框架,用于部署和与 WordPress 一起工作。这是一个为 WordPress 开发者构建的出色的框架,充满了爱心。


README

Olympus

Olympus Component CodeFactor Grade Packagist Version PHP Version Travis Status MIT

Olympus 包是安装带有强大 Zeus Core 框架的 WordPress 网站的 最简单和安全 的方式。这里列出了所有 WordPress 优化并已启用。您可以轻松使用主题。

# Quick install ~ See #install-olympus-in-2-steps section for details
git clone https://github.com/GetOlympus/Olympus.git projectname && cd $_
composer install

目录

什么是 Olympus?

Olympus 包是一组代码,为开发者提供了一个安全的 WordPress 应用程序结构,并提供了更好的工具。它针对所有级别的 WordPress 开发者。

为了提供这些工具,Olympus 包使用了依赖管理器和远程服务器自动化工具,如 ComposerCapistrano。一些自动生成的文件和自动加载的插件使您的 WordPress 网站更安全且更快。

功能

  • 更好的安全文件夹结构
  • mu 插件的自动加载器
  • 使用 composer install 自动生成的配置文件
  • 使用 Composer 进行依赖管理
  • 使用 CapistranoOlympus Hestia Capistrano 进行远程服务器自动化

入门

两步安装 Olympus

第一步,克隆存储库(如果您想使用 SSH 密钥,请使用 git@github.com:GetOlympus/Olympus.git)

# Change "projectname" to your root website folder name
git clone https://github.com/GetOlympus/Olympus.git projectname && cd $_

第二步,通过 Composer 安装包供应商并在询问时设置您的参数
请参阅 此文档 了解如何安装 Composer

composer install

更新 Vhost

这很简单:将 web/ 文件夹作为您的文档根目录。
web/index.php 文件将使用所有配置文件引导 WordPress。
重新启动您的服务器,就绪了。

构建数据库

转到您的网站主页 URL 以启动 WordPress 安装。

使用 Capistrano 入门

Capistrano 是一个远程服务器自动化工具。
它支持脚本化和执行任意任务,并包含一系列合理的默认部署工作流程。

您可以在 Capistrano 网站 上找到所有详细信息。

构建脚本

您需要为所有环境创建您的部署脚本。这些脚本是用 Ruby 编程语言编写的。
Olympus 包提供了 2 个示例,您可以轻松复制/粘贴到 app/deploy/stages/ 文件夹中

# You can find all explanations as comments in the `app/deploy/stages/staging.rb.dist` file.
cp app/deploy/stages/production.rb.dist app/deploy/stages/production.rb
cp app/deploy/stages/staging.rb.dist app/deploy/stages/staging.rb

请随意阅读 Olympus Hestia Capistrano 存储库的 README.md 文件以获取更多信息。

使用 Capistrano 更新 Vhost

如“更新Vhost”部分所示,这次您需要将current/web/文件夹设置为您的docroot。
重新启动您的服务器,就绪了。

使用 Capistrano 构建数据库

前往您的网站首页URL以启动WordPress网站的安装。

高级详情

应用程序结构

“Olympus”包的结构如下

+-- app/                        # ~ main application folder
|  +-- cache/                   # stores cache files generated by WordPress plugins and Olympus components
|  +-- components/              # stores custom components used to autoload mu-plugins and error logger
   |  +-- Autoloader
   |  +-- Error
   |  +-- Handler
|  +-- config/                  # stores custom configuration files
   |  +-- env.php.dist
   |  +-- opts.php.dist
   |  +-- own.php.dist
   |  +-- salt.php.dist
|  +-- deploy/                  # stores Capistrano workflows deployments
   |  +-- stages/
      |  +-- production.rb.dist
      |  +-- staging.rb.dist
   |  +-- config.rb.dist
|  +-- environments/            # stores WordPress constants definitions
   |  +-- cache.php
   |  +-- configuration.php
   |  +-- cookies.php
   |  +-- database.php
   |  +-- debug.php
   |  +-- multisite.php
   |  +-- website.php
|  +-- logs/                    # stores log file generated by Monolog package
|  +-- app.php
|  +-- autoload.php
|  +-- environment.php
|  +-- error.php
+-- vendor/                     # ~ vendors downloaded with composer
+-- web/                        # ~ web server doc root
|  +-- cms/                     # stores default WordPress installation
|  +-- resources/               # stores assets files expected by Olympus bundles
   |  +-- dist/
|  +-- statics/                 # stores default "wp-content" folder contents
   |  +-- languages/
   |  +-- mu-plugins/
   |  +-- plugins/
   |  +-- themes/
   |  +-- uploads/
   |  +-- advanced-cache.php
|  +-- .htaccess.dist
|  +-- constants.php            # defines default Olympus package constants
|  +-- favicon.ico              # custom favicon.ico made by anischouk.com
|  +-- index.php                # ~ main file, bootstraps WordPress
|  +-- robots.txt.dist
|  +-- wp-config.php
|  +-- xmlrpc.php
+-- .gitattributes
+-- .gitignore
+-- .travis.yml
+-- Capfile
+-- CHANGELOG.md
+-- composer.json
+-- Gemfile
+-- LICENCE
+-- phpcs.xml
+-- README.md
+-- wp-cli.yml

配置文件

前往您的app/config/文件夹,并确保找到

  • env.php,包含WordPress网站环境配置
  • own.php,一个简单的空白PHP文件,您可以在其中填写自己的常量定义
  • salt.php,包含WordPress认证的唯一密钥和盐值

如果需要,您可以创建的其他文件是

  • opts.php,包含WordPress常量覆盖。只需将opts.php.dist文件复制到opts.php并编辑它。
    小心此文件:您可以更改WordPress的核心函数
    查看变量定义以了解更多关于此opts.php文件内容的信息。

变量定义

配置部分,设置内存限制、一些安全和功能选项

Cookie部分,设置所有Cookie名称。
在这些示例中,您可以替换

  • olympusmd5('olympus')的结果
  • domaintldmd5('https://www.domain.tld/cms/')的结果

调试部分,设置所有调试选项

多站部分,在多站情况下设置默认当前站点定义

网站部分,设置所有静态文件夹名称

日志级别

  • 100 详细调试信息。
  • 200 有趣的事件,如用户登录、SQL日志。
  • 250 不常见的事件。
  • 300 非错误异常发生,如使用已弃用的API、API使用不当等。
  • 400 运行时错误。
  • 500 严重条件。
  • 550 必须立即采取行动。
  • 600 紧急警报。

发布历史

有关所有详细信息,请参阅CHANGELOG.md

贡献

  1. 分叉它(https://github.com/GetOlympus/Olympus/fork
  2. 创建您的功能分支(git checkout -b feature/fooBar
  3. 提交您的更改(git commit -am '添加一些fooBar'
  4. 推送到分支(git push origin feature/fooBar
  5. 创建新的Pull Request

Achraf Chouk用♥构建 ~ (c)很长时间以来。
Logo设计由Anis Chouk精心制作