Files
WPIQ/README.md

169 lines
7.2 KiB
Markdown
Raw Normal View History

<p align="center"><img src="https://raw.githubusercontent.com/WordOps/WordOps/master/logo.png" width="400" alt="Wordops" /><a href="https://wordops.net">
2019-04-07 12:57:35 +02:00
<br>
2019-04-07 12:57:35 +02:00
</p>
2018-11-13 21:55:59 +01:00
<h2 align="center">An essential toolset that eases WordPress site and server administration</h2>
2018-11-14 19:26:05 +01:00
2019-03-22 15:52:59 +01:00
<p align="center">
2019-03-27 05:05:02 +01:00
<img src="https://img.virtubox.net/images/2019/03/27/wordops-stable-4.mp4.gif" width="600" alt="WordOps" />
2019-03-22 15:52:59 +01:00
2019-03-27 04:26:12 +01:00
</p>
2019-03-22 15:52:59 +01:00
<p align="center">
2019-04-29 13:13:44 +02:00
<a href="https://travis-ci.org/WordOps/WordOps" target="_blank"><img src="https://travis-ci.org/WordOps/WordOps.svg?branch=master" alt="build"></a>
<img src="https://img.shields.io/github/license/wordops/wordops.svg" alt="MIT">
<img src="https://img.shields.io/github/last-commit/wordops/wordops.svg" alt="Commits">
2019-05-02 18:41:07 +02:00
<img alt="GitHub release" src="https://img.shields.io/github/release/WordOps/WordOps.svg">
2019-04-29 13:13:44 +02:00
<br><a href="https://www.codacy.com/app/VirtuBox/WordOps?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=WordOps/WordOps&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/fe9100fd2c634de7882ecec17f00a11a"/></a>
<a href="https://twitter.com/WordOps_" target="_blank"><img src="https://img.shields.io/badge/twitter-%40WordOps__-blue.svg?style=flat&logo=twitter" alt="Badge Twitter" /></a>
<a href="https://community.wordops.net/slack" target="_blank"><img src="https://img.shields.io/badge/slack-WordOps-4A154B.svg?style=flat&logo=slack" alt="Badge Slack" /></a>
</p>
2018-11-13 21:55:59 +01:00
<p align="center">
<a href="#key-features">Key Features</a> •
<a href="#usage">Usage</a> •
<a href="https://github.com/WordOps/WordOps/projects">RoadMap</a> •
<a href="https://github.com/WordOps/WordOps/blob/master/CHANGELOG.md">Changelog</a> •
<a href="#credits">Credits</a> •
<a href="#license">License</a>
</p>
2019-03-29 12:17:17 +01:00
<p align="center">
2019-04-29 13:13:44 +02:00
<a href="https://wordops.net" target="_blank"> WordOps.net</a> •
<a href="https://docs.wordops.net" target="_blank">Documentation</a> •
<a href="https://community.wordops.net" target="_blank">Community forum</a> •
<a href="https://demo.wordops.eu" target="_blank">Dashboard demo</a>
2019-03-29 12:17:17 +01:00
</p>
2018-11-13 21:55:59 +01:00
---
## Key Features
2019-03-27 04:26:12 +01:00
- **Easy to install** : One step automated installer with migration from EasyEngine v3 support
- **Fast deployment** : Fast and automated WordPress, Nginx, PHP, MySQL & Redis installation
2019-07-15 10:43:40 +02:00
- **Custom Nginx build** : Nginx 1.16.0 - TLS v1.3 Cloudflare HTTP/2 HPACK & Brotli support
- **Up-to-date** : PHP 7.2 & 7.3, MariaDB 10.3 & Redis 5.0
2019-03-27 04:26:12 +01:00
- **Secured** : Hardened WordPress security with strict Nginx location directives
- **Powerful** : Optimized Nginx configurations with multiple cache backends support
2019-07-15 10:43:40 +02:00
- **SSL** : Domain, Subdomain & Wildcard Let's Encrypt SSL certificates handled by acme.sh
- **Modern** : Strong ciphers_suite, modern TLS protocols and HSTS support (Grade A+ on ssllabs)
2019-04-10 21:45:02 +02:00
- **Monitoring** : Live Nginx vhost traffic with ngx_vts_module and server monitoring with Netdata
## Requirements
### Operating System
2019-03-15 16:45:10 +01:00
- Ubuntu 16.04 LTS (Xenial)
- Ubuntu 18.04 LTS (Bionic)
2019-04-29 13:13:44 +02:00
- Ubuntu 19.04 (Disco)
2019-03-15 16:45:10 +01:00
- Debian 8 (Jessie)
2019-03-18 14:19:30 +01:00
- Debian 9 (Stretch)
2019-07-19 13:47:29 +02:00
- Debian 10 (Buster) - Not ready for production
- Raspbian 9 (Stretch)
### Ports requirements
- SSH (22 or custom)
- HTTP & HTTPS (80 & 443)
- WO Admin (22222)
- GPG key Server (11371 outbound)
## Getting Started
2018-11-13 21:55:59 +01:00
```bash
2019-04-19 05:35:39 +02:00
wget -qO wo wops.cc && sudo bash wo # Install WordOps
2018-11-13 21:55:59 +01:00
sudo wo site create example.com --wp # Install required packages & setup WordPress on example.com
```
## Must read
2018-11-13 21:55:59 +01:00
2019-07-19 13:47:29 +02:00
[From EasyEngine to WordOps](https://docs.wordops.net/about/from-easyengine-to-wordops/)
2019-03-15 17:08:47 +01:00
## Usage
2018-11-13 21:55:59 +01:00
### Standard WordPress sites
```bash
wo site create example.com --wp # install wordpress without any page caching
2019-03-07 16:14:30 +01:00
wo site create example.com --wp --php73 # install wordpress with PHP 7.3 without any page caching
2018-11-13 21:55:59 +01:00
wo site create example.com --wpsc # install wordpress with wp-super-cache plugin
wo site create example.com --wpfc # install wordpress + nginx fastcgi_cache
wo site create example.com --wpredis # install wordpress + nginx redis_cache
```
2019-03-15 16:45:10 +01:00
### WordPress multisite with subdirectory
2018-11-13 21:55:59 +01:00
```bash
wo site create example.com --wpsubdir # install wpmu-subdirectory without any page caching
wo site create example.com --wpsubdir --wpsc # install wpmu-subdirectory with wp-super-cache plugin
wo site create example.com --wpsubdir --wpfc # install wpmu-subdirectory + nginx fastcgi_cache
wo site create example.com --wpsubdir --wpredis # install wpmu-subdirectory + nginx redis_cache
```
2019-03-15 16:45:10 +01:00
### WordPress multisite with subdomain
2018-11-13 21:55:59 +01:00
```bash
wo site create example.com --wpsubdomain # install wpmu-subdomain without any page caching
wo site create example.com --wpsubdomain --wpsc # install wpmu-subdomain with wp-super-cache plugin
wo site create example.com --wpsubdomain --wpfc # install wpmu-subdomain + nginx fastcgi_cache
wo site create example.com --wpsubdomain --wpredis # install wpmu-subdomain + nginx redis_cache
```
### Non-WordPress sites
2018-11-13 21:55:59 +01:00
```bash
wo site create example.com --html # create example.com for static/html sites
wo site create example.com --php # create example.com with php support
wo site create example.com --mysql # create example.com with php & mysql support
2019-03-15 16:45:10 +01:00
wo site create example.com --proxy=127.0.0.1:3000 # create example.com with nginx as reverse-proxy
2018-11-13 21:55:59 +01:00
```
2019-03-18 00:30:54 +01:00
### Sites secured with Let's Encrypt
```bash
2019-07-19 13:47:29 +02:00
wo site create example.com --wp --letsencrypt # wordpress secured with letsencrypt
wo site create sub.example.com --wp --letsencrypt=subdomain # wordpress + letsencrypt subdomain
2019-04-17 14:16:38 +02:00
wo site create site.tld --wp --letsencrypt --hsts # install wordpress & secure site with letsencrypt with HSTS
2019-07-19 13:47:29 +02:00
wo site create site.tld --wp --letsencrypt=wildcard --dns=dns_cf # install wordpress & issue a wildcard SSL certificate with Cloudflare DNS API
2019-03-18 00:30:54 +01:00
```
## Update WordOps
```bash
wo update
```
## Support
2019-04-12 02:43:41 +02:00
If you feel there is a bug directly related to WordOps, or if you want to suggest new features for WordOps, feel free to open an issue.
For any other questions about WordOps or if you need support, please use the [Community Forum](https://community.wordops.net/).
# Contributing
If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.
2019-03-29 12:17:17 +01:00
There is no need to be a developer or a system administrator to contribute to WordOps project. You can still contribute by helping us to improve [WordOps documentation](https://github.com/WordOps/docs.wordops.net).
## Credits
2019-04-16 11:16:55 +02:00
- Source : [EasyEngine](https://github.com/easyengine/easyengine)
Apps & Tools shipped with WordOps :
2019-04-16 11:16:55 +02:00
2019-04-23 19:03:42 +02:00
- [Acme.sh](https://github.com/Neilpang/acme.sh)
- [WP-CLI](https://github.com/wp-cli/wp-cli)
- [Netdata](https://github.com/netdata/netdata)
2019-04-16 11:16:55 +02:00
- [phpMyAdmin](https://www.phpmyadmin.net/)
2019-04-23 19:03:42 +02:00
- [Composer](https://github.com/composer/composer)
2019-04-16 11:16:55 +02:00
- [Adminer](https://www.adminer.org/)
- [phpRedisAdmin](https://github.com/erikdubbelboer/phpRedisAdmin)
- [opcacheGUI](https://github.com/amnuts/opcache-gui)
- [eXtplorer](https://github.com/soerennb/extplorer)
- [MySQLTuner](https://github.com/major/MySQLTuner-perl/)
- [Webgrind](https://github.com/jokkedk/webgrind)
2019-07-15 10:43:40 +02:00
- [MySQLTuner](https://github.com/major/MySQLTuner-perl)
2019-03-18 14:19:30 +01:00
2018-11-13 21:55:59 +01:00
## License
2019-03-29 12:17:17 +01:00
- [MIT](http://opensource.org/licenses/MIT) © [WordOps](https://wordops.net)