From b052a2d95586182a9a1b08bdf412779103618821 Mon Sep 17 00:00:00 2001 From: Argus Duong Date: Fri, 30 Aug 2019 09:30:15 +0700 Subject: [PATCH] Typo --- README.md | 16 ++++---- about/redistributed.md | 2 +- docs/README.md | 20 +++++----- docs/about/changelog.md | 14 +++---- docs/about/contributing.md | 2 +- docs/about/from-easyengine-to-wordops.md | 8 ++-- docs/commands.md | 2 +- docs/commands/clean.md | 2 +- docs/commands/debug.md | 2 +- docs/commands/info.md | 2 +- docs/commands/log.md | 4 +- docs/commands/maintenance.md | 4 +- docs/commands/secure.md | 12 +++--- docs/commands/site.md | 38 +++++++++---------- docs/commands/stack.md | 22 +++++------ docs/commands/update.md | 2 +- docs/css/extra.css | 2 +- docs/faq.md | 4 +- docs/getting-started/creating-sites.md | 4 +- docs/getting-started/installation-guide.md | 8 ++-- docs/getting-started/post-install-steps.md | 4 +- docs/getting-started/prerequesites.md | 4 +- docs/guides.md | 2 +- docs/guides/manage-ssl-certificates.md | 16 ++++---- docs/guides/migration-from-easyengine.md | 24 ++++++------ docs/how-to.md | 10 ++--- ...onfigure-letsencrypt-dns-api-validation.md | 28 +++++++------- docs/how-to/configure-ufw-firewall.md | 2 +- docs/how-to/get-a-plus-grade-ssllabs.md | 2 +- docs/how-to/secure-22222.md | 6 +-- docs/security/recommendations.md | 2 +- docs/troubleshooting.md | 16 ++++---- 32 files changed, 143 insertions(+), 143 deletions(-) diff --git a/README.md b/README.md index 4e5224b6..4cd6d7a4 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ You can either edit page content from Github or fork the repository before cloni If you have any question about this documentation, feel free to join us on [Slack](https://community.wordops.io/slack) or to ask your question on [WordOps Community forum](https://community.wordops.net/) -### Method 1 : Edit page content directly from Github +### Method 1: Edit page content directly from Github ![edit](https://img.virtubox.net/images/2019/03/29/image.png) @@ -20,14 +20,14 @@ If you have any question about this documentation, feel free to join us on [Slac 4. After you finished making changes, you will be able to commit changes (saving changes with a message which describe what was added/changed/removed). 5. The last step to apply changes on this repository is to open a PR(pull request). We will review the commits you made and if everything is okay, we will merge the PR. -### Method 2 : Work on the documentation locally +### Method 2: Work on the documentation locally -If you want to work on WordOps documentation on your computer, you just have to : +If you want to work on WordOps documentation on your computer, you just have to: 1. Fork the repository using the button "Fork" available on the top right of this page -2. clone the forked repository : +2. clone the forked repository: - - with the CLI : `git clone https://github.com/YourUsername/docs.wordops.net.git` + - with the CLI: `git clone https://github.com/YourUsername/docs.wordops.net.git` - or using [Github Desktop App](https://desktop.github.com/) 3. create/edit markdown files @@ -38,7 +38,7 @@ If you want to work on WordOps documentation on your computer, you just have to ### Documentation structure Documentation source files are stored inside `docs` directory. -Here the current structure : +Here the current structure: ```bash ├── commands # commands folder @@ -67,7 +67,7 @@ Here the current structure : Each part of the documentation is stored in a separated folder. `how-to` is the folder used for any short tutorial or explanation about WordOps usage. `guides` is the folder used for any extended guide or tutorial about WordOps. -Example : +Example: > I want to write a tutorial to explain how to use WordOps with a remote MySQL server. @@ -83,7 +83,7 @@ MkDocs builds completely static HTML sites that you can host on GitHub page or a You can install Mkdocs locally to use the site live preview feature. -- install mkdocs : +- install mkdocs: - [guide for windows](https://gist.github.com/VirtuBox/2f149ce45e2449c36f18cb634243fe90) - `apt install mkdocs -y` on debian/ubuntu - start mkdocs built-in web-server `mkdocs serve` or `mkdocs.exe serve` inside the repository folder diff --git a/about/redistributed.md b/about/redistributed.md index 95339d8e..c2c4c6b5 100644 --- a/about/redistributed.md +++ b/about/redistributed.md @@ -1,5 +1,5 @@ # Redistributed Software -WordOps redistribute the following third-party software : +WordOps redistribute the following third-party software: - diff --git a/docs/README.md b/docs/README.md index 3c93181f..da2a55d5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -40,16 +40,16 @@ ## Key Features -- **Easy to install** : One step automated installer with migration from EasyEngine v3 support -- **Fast deployment** : Fast and automated WordPress, Nginx, PHP, MySQL & Redis installation -- **Custom Nginx build** : Nginx 1.16.1 - TLS v1.3 Cloudflare HTTP/2 HPACK & Brotli support -- **Up-to-date** : PHP 7.2 & 7.3, MariaDB 10.3 & Redis 5.0 -- **Secured** : Hardened WordPress security with strict Nginx location directives -- **Powerful** : Optimized Nginx configurations with multiple cache backends support -- **SSL** : Domain, Subdomain & Wildcard Let's Encrypt SSL certificates with DNS API -- **Modern** : Strong ciphers_suite, modern TLS protocols and HSTS support (Grade A+ on [ssllabs](https://www.ssllabs.com/ssltest/analyze.html?d=demo.wordops.eu&latest)) -- **Monitoring** : Live Nginx vhost traffic with ngx_vts_module and server monitoring with Netdata -- **User Friendly** : WordOps dashboard with server status/monitoring and tools ([demo](https://demo.wordops.eu)) +- **Easy to install**: One step automated installer with migration from EasyEngine v3 support +- **Fast deployment**: Fast and automated WordPress, Nginx, PHP, MySQL & Redis installation +- **Custom Nginx build**: Nginx 1.16.1 - TLS v1.3 Cloudflare HTTP/2 HPACK & Brotli support +- **Up-to-date**: PHP 7.2 & 7.3, MariaDB 10.3 & Redis 5.0 +- **Secured**: Hardened WordPress security with strict Nginx location directives +- **Powerful**: Optimized Nginx configurations with multiple cache backends support +- **SSL**: Domain, Subdomain & Wildcard Let's Encrypt SSL certificates with DNS API +- **Modern**: Strong ciphers_suite, modern TLS protocols and HSTS support (Grade A+ on [ssllabs](https://www.ssllabs.com/ssltest/analyze.html?d=demo.wordops.eu&latest)) +- **Monitoring**: Live Nginx vhost traffic with ngx_vts_module and server monitoring with Netdata +- **User Friendly**: WordOps dashboard with server status/monitoring and tools ([demo](https://demo.wordops.eu)) --- diff --git a/docs/about/changelog.md b/docs/about/changelog.md index 5cab7e92..9cf75531 100644 --- a/docs/about/changelog.md +++ b/docs/about/changelog.md @@ -4,7 +4,7 @@ ### Added -- cht.sh stack : linux online cheatsheet. Usage : `cheat `. Example for tar : `cheat tar` +- cht.sh stack: linux online cheatsheet. Usage: `cheat `. Example for tar: `cheat tar` - ClamAV anti-virus with weekly cronjob to update signatures database - Internal function to add daily cronjobs - Additional comment to detect previous configuration tuning (MariaDB & Redis) @@ -24,7 +24,7 @@ ### Fixed -- typo error in `wo site update` : [PR #126](https://github.com/WordOps/WordOps/pull/126) +- typo error in `wo site update`: [PR #126](https://github.com/WordOps/WordOps/pull/126) ## v3.9.8.3 - 2019-08-22 @@ -48,7 +48,7 @@ - Additional settings to support mobile with WP-Rocket - Add the ability to block nginx configuration overwriting by adding a file .custom. Example with /etc/nginx/conf.d/webp.conf -> `touch /etc/nginx/conf.d/webp.conf.custom` - If there is a custom file, WordOps will write the configuration in a file named fileconf.conf.orig to let users implement possible changes -- UFW minimal configuration during install. Can be disabled with the flag `-w`, `--wufw` or `--without-ufw`. Example : `wget -qO wo wops.cc && sudo bash wo -w` +- UFW minimal configuration during install. Can be disabled with the flag `-w`, `--wufw` or `--without-ufw`. Example: `wget -qO wo wops.cc && sudo bash wo -w` ### Fixed @@ -256,7 +256,7 @@ - WP_CACHE_KEY_SALT set twice with wpredis - WordOps version check when using `wo update` - robots.txt file download if not created -- PHP-FPM socket path in stub_status.conf : PR [#82](https://github.com/WordOps/WordOps/pull/82) +- PHP-FPM socket path in stub_status.conf: PR [#82](https://github.com/WordOps/WordOps/pull/82) ## v3.9.5.1 - 2019-05-10 @@ -281,9 +281,9 @@ - WordOps configuration backup before upgrade - Previous acme.sh certs migration - "wo maintenance" command to perform server package update & cleanup -- Support for Netdata on backend : https://server.hostname:22222/netdata/ -- New Stacks : composer and netdata -- additional argument for letsencrypt : --hsts +- Support for Netdata on backend: https://server.hostname:22222/netdata/ +- New Stacks: composer and netdata +- additional argument for letsencrypt: --hsts - Clean Theme for adminer - Credits for tools shipped with WordOps - Cache exception for Easy Digital Download diff --git a/docs/about/contributing.md b/docs/about/contributing.md index c0171ddb..d97c618b 100644 --- a/docs/about/contributing.md +++ b/docs/about/contributing.md @@ -78,7 +78,7 @@ wo ``` -Plugins Directory : +Plugins Directory: Here the list of plugins with the related command or a short description ```tree diff --git a/docs/about/from-easyengine-to-wordops.md b/docs/about/from-easyengine-to-wordops.md index d90bb149..5733ef28 100644 --- a/docs/about/from-easyengine-to-wordops.md +++ b/docs/about/from-easyengine-to-wordops.md @@ -6,15 +6,15 @@ WordOps was forked from EasyEngine v3, with the objective of providing an up-to- ## Fundamental changes - We've deprecated the mail stack. As an alternative, you can take a look at [Mail-in-a-Box](https://github.com/mail-in-a-box/mailinabox), [iRedMail](https://www.iredmail.org/) or [Caesonia](https://github.com/vedetta-com/caesonia). As Roundcube alternative, there is [Rainloop](https://www.rainloop.net/) or [Afterlogic WebMail](https://github.com/afterlogic/webmail-lite-8) -- Support for w3tc is dropped as a security precaution. +- Support for W3TC is dropped as a security precaution. - PHP 5.6 has been replaced by PHP 7.2 and PHP 7.0 has been replaced by PHP 7.3. - Nginx-ee package has been replaced by Nginx-wo (based on Nginx stable v1.16.0 with Brotli support) - HHVM stack has been removed - Memcached stack has been removed - Let's Encrypt stack isn't based on letsencrypt-auto anymore, we use acme.sh to handle SSL certificates -If you are going to migrate from EasyEngine v3, here some important informations : +If you are going to migrate from EasyEngine v3, here some important informations: -- Previous php upstreams in Nginx will not be overwritted -- php5.6 and php7.0 will not be removed or uninstalled +- Previous PHP upstreams in Nginx will not be overwritted +- PHP 5.6 and PHP 7.0 will not be removed or uninstalled - Previous Nginx common configurations will not be overwritted \ No newline at end of file diff --git a/docs/commands.md b/docs/commands.md index 517b3ae0..3cad0c11 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -1,6 +1,6 @@ # WordOps commands -The WordOps commands structure : +The WordOps commands structure: ```bash wo (command) [options] diff --git a/docs/commands/clean.md b/docs/commands/clean.md index aba6dd95..032829f9 100644 --- a/docs/commands/clean.md +++ b/docs/commands/clean.md @@ -2,7 +2,7 @@ Clean NGINX FastCGI cache, Opcache, Redis Cache -Usage : +Usage: ```bash wo clean [options] diff --git a/docs/commands/debug.md b/docs/commands/debug.md index 7bc75770..117af535 100644 --- a/docs/commands/debug.md +++ b/docs/commands/debug.md @@ -2,7 +2,7 @@ Used for server level debugging -Usage : +Usage: ```bash wo debug [options] diff --git a/docs/commands/info.md b/docs/commands/info.md index 69a055a0..42a933cf 100644 --- a/docs/commands/info.md +++ b/docs/commands/info.md @@ -4,7 +4,7 @@ Display configuration information related to Nginx, PHP and MySQL -Usage : +Usage: ```bash wo info [options] diff --git a/docs/commands/log.md b/docs/commands/log.md index 0231ddef..88812fb1 100644 --- a/docs/commands/log.md +++ b/docs/commands/log.md @@ -2,7 +2,7 @@ Perform operations on Nginx, PHP and MySQL log files -Usage : +Usage: ```bash wo log [] [options] @@ -19,7 +19,7 @@ subcommand | description Show Nginx, PHP, MySQL log file -Usage : +Usage: ```bash wo log show [] [options] diff --git a/docs/commands/maintenance.md b/docs/commands/maintenance.md index 6a38e407..06961891 100644 --- a/docs/commands/maintenance.md +++ b/docs/commands/maintenance.md @@ -5,13 +5,13 @@ Update apt-cache and upgrade packages. -Usage : +Usage: ```bash wo maintenance ``` -This command is equivalent to : +This command is equivalent to: ```bash apt update diff --git a/docs/commands/secure.md b/docs/commands/secure.md index 09eb2be6..4c81a133 100644 --- a/docs/commands/secure.md +++ b/docs/commands/secure.md @@ -5,18 +5,18 @@ Secure command secure WordOps backend auth, ip and port -Usage : +Usage: ```bash wo secure [options] ``` -Options : +Options: argument | description ------------------ | ----------- --auth | Set backend user credentials (user and) ---port | Set backend port (default : 22222) +--port | Set backend port (default: 22222) --ip | Set the list of IP(s) allowed to access without authentification WordOps uses [Basic Auth](https://docs.nginx.com/nginx/admin-guide/security-controls/configuring-http-basic-authentication/) to protect the backend from unauthorize people. To change the authorization method, backend's port,... You can use `wo secure` command. @@ -27,8 +27,8 @@ The user name and password of WordOps backend is showed when you create a first ```bash wo secure --auth -Provide HTTP authentication user name [admin] :master -Provide HTTP authentication password [5zVFELjHjShPPFr7qkoMzavP] : +Provide HTTP authentication user name [admin]:master +Provide HTTP authentication password [5zVFELjHjShPPFr7qkoMzavP]: ``` Short hand: @@ -44,7 +44,7 @@ In case you want to change WordOps backend port from `22222`, use this command: ```bash wo secure --port WordOps admin port [22222]:23456 -Reload : nginx [OK] +Reload: nginx [OK] Successfully port changed 23456 ``` diff --git a/docs/commands/site.md b/docs/commands/site.md index 2bd5e16c..5e028b07 100644 --- a/docs/commands/site.md +++ b/docs/commands/site.md @@ -2,7 +2,7 @@ Performs website specific operations -Usage : +Usage: ```bash wo site (command) [options] @@ -67,7 +67,7 @@ To create site with Proxy configuration you can use --proxy during site creation wo site create site.tld --proxy=127.0.0.1:3000 ``` -This will create proxy site site.tld with proxy destination as 127.0.0.1:3000. Port is optional. Default port : 80. +This will create proxy site site.tld with proxy destination as 127.0.0.1:3000. Port is optional. Default port: 80. ### WordPress @@ -140,7 +140,7 @@ To define WordPress administrator password during site creation use wo site create site.tld --pass=password ``` -This will set defined password as administrator password. If not defined it will generate random pasword for administrator. If you have special characters, you can quote them using single quotes like this : +This will set defined password as administrator password. If not defined it will generate random pasword for administrator. If you have special characters, you can quote them using single quotes like this: ```bash --pass='my$secret&' @@ -198,7 +198,7 @@ wo site create sub.site.tld --wp --letsencrypt -Example with Cloudflare DNS : +Example with Cloudflare DNS: ```bash export CF_Key="d7eab56a903f25dd4xxxxxxxxxxxxxxxxxxxx" @@ -234,7 +234,7 @@ For example, you can create WordPress site running on PHP 7.3 using following co wo site create site.tld --wp --php73 ``` -To create simple php site running with PHP 7.3 with no database, you can use this command : +To create simple php site running with PHP 7.3 with no database, you can use this command: ```bash wo site create site.tld --php73 @@ -248,7 +248,7 @@ Update site configuration `wo site update` command follows following procedure while updating current site. -Before Updating any site : +Before Updating any site: * Creates nginx configuration backup for site. * Moves htdocs to backup while updating html/php/mysql site. @@ -300,13 +300,13 @@ Before Updating any site : -Example : updating site from basic wp to wp + fastcgi_cache : +Example: updating site from basic wp to wp + fastcgi_cache: ### Usage -Usage : +Usage: ```bash wo site update [] [options] @@ -331,7 +331,7 @@ wo site update [] [options] | `--letsencrypt`,`-le` | secure site with Let's Encrypt SSL certificate | | `--letsencrypt=wildcard` | secure site/multisite with a wildcard SSL certificates | | `--letsencrypt=off` | disable Let's Encrypt SSL certificate | -| `--dns`, `--dns=` | issue Let's Encrypt certificate with DNS validation. default : `dns_cf` | +| `--dns`, `--dns=` | issue Let's Encrypt certificate with DNS validation. default: `dns_cf` | | `--hsts` | Enable HSTS on site secured with Let's Encrypt | | `--hsts=off` | Disable HSTS | @@ -349,7 +349,7 @@ Update a WordPress site running with PHP 7.2 to PHP 7.3 wo site update site.tld --php73 ``` -Disable PHP 7.3 and use PHP 7.2 : +Disable PHP 7.3 and use PHP 7.2: ```bash wo site update site.tld --php73=off @@ -365,7 +365,7 @@ wo site update site.tld --wpredis Get site information including cache backend, PHP version or user database credentials -Usage : +Usage: ```bash wo site info [] @@ -373,9 +373,9 @@ wo site info [] ## site delete -Delete site including webroot and database : +Delete site including webroot and database: -Usage : +Usage: ```bash wo site delete [] [options] @@ -391,7 +391,7 @@ wo site delete [] [options] Edit site Nginx configuration -Usage : +Usage: ```bash wo site edit [] @@ -403,7 +403,7 @@ You will be prompted to choose the text editor you prefer. Nano is highly recomm Move into a site webroot directory -Usage : +Usage: ```bash wo site cd [] @@ -413,7 +413,7 @@ wo site cd [] List all sites managed with WordOps -Usage : +Usage: ```bash wo site list @@ -423,7 +423,7 @@ wo site list Display site Nginx configuration -Usage : +Usage: ```bash wo site show [] @@ -433,7 +433,7 @@ wo site show [] Disable site Nginx vhost -Usage : +Usage: ```bash wo site disable [] @@ -443,7 +443,7 @@ wo site disable [] Enable site Nginx vhost -Usage : +Usage: ```bash wo site enable [] diff --git a/docs/commands/stack.md b/docs/commands/stack.md index 61909284..cadf12fd 100644 --- a/docs/commands/stack.md +++ b/docs/commands/stack.md @@ -2,7 +2,7 @@ Manage server stack operations -Usage : +Usage: ```bash wo stack (command) [options] @@ -23,7 +23,7 @@ subcommand | description !!! info Options are the same for `wo stack install`, `wo stack remove` and `wo stack purge` -Stack available are : +Stack available are: | options | type | description | | ----------------- | ----------- | ------------------------------------------------------- | @@ -54,7 +54,7 @@ Stack available are : ## stack install -Usage : +Usage: ```bash wo stack install [options] @@ -96,7 +96,7 @@ After installing the Admin stack, WordOps dashboard will be available on https:/ Upgrade stack safely and apply new configurations and optimizations -Usage : +Usage: ```bash wo stack upgrade [options] @@ -128,7 +128,7 @@ Currently `wo stack upgrade --mysql` will only update the package from the curre Remove stacks (without removing configurations or data for APT packages) -Usage : +Usage: ```bash wo stack remove [options] @@ -148,7 +148,7 @@ Remove and purge stacks (including configurations and data) !!! Warning Please be careful when using `wo stack purge` because it will remove APT packages but also purge all configurations or data, including MySQL databases, Redis databases or Nginx vhosts. -Usage : +Usage: ```bash wo stack purge [options] @@ -163,7 +163,7 @@ wo stack purge [options] Restart Stack service -Usage : +Usage: ```bash wo stack restart [options] @@ -173,7 +173,7 @@ wo stack restart [options] Reload Stack service -Usage : +Usage: ```bash wo stack reload [options] @@ -183,7 +183,7 @@ wo stack reload [options] Start Stack service -Usage : +Usage: ```bash wo stack start [options] @@ -193,7 +193,7 @@ wo stack start [options] Stop Stack service -Usage : +Usage: ```bash wo stack stop [options] @@ -203,7 +203,7 @@ wo stack stop [options] Display Stack service status -Usage : +Usage: ```bash wo stack status [options] diff --git a/docs/commands/update.md b/docs/commands/update.md index 321826ca..adc0e5b8 100644 --- a/docs/commands/update.md +++ b/docs/commands/update.md @@ -4,7 +4,7 @@ Update WordOps to the latest release available -Usage : +Usage: ```bash wo update [options] diff --git a/docs/css/extra.css b/docs/css/extra.css index 38cf375c..917d78ab 100644 --- a/docs/css/extra.css +++ b/docs/css/extra.css @@ -119,7 +119,7 @@ pre { font-family: 'Roboto Mono'; } -.md-typeset__table tr :nth-child(1) { +.md-typeset__table tr:nth-child(1) { word-wrap: break-word; max-width: 30em } diff --git a/docs/faq.md b/docs/faq.md index 55bc8987..75dffe36 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -25,7 +25,7 @@ WordOps support PHP 7.2 (default) and PHP 7.3. There is no "best solution", because there are benefits/disadvantage for each caching solution and it depend on your usage. -Here some informations : +Here some informations: | Cache backend | command argument | description | | -------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | @@ -57,7 +57,7 @@ WordOps Let's Encrypt stack is fully compatible with Cloudflare CDN, and you can ### How to uninstall WordOps ? -If you need/want to uninstall WordOps, you can use the following commands : +If you need/want to uninstall WordOps, you can use the following commands: !!! warning Make a backup of your databases before purging wordops packages diff --git a/docs/getting-started/creating-sites.md b/docs/getting-started/creating-sites.md index ed90d6c4..d7687cd6 100644 --- a/docs/getting-started/creating-sites.md +++ b/docs/getting-started/creating-sites.md @@ -5,13 +5,13 @@ You can create site with WordOps by using the command `wo site create`. -WordOps will always : +WordOps will always: - install required stack if needed - configure Nginx vhost - create site directory -WordOps can also : +WordOps can also: - create the site database - install WordPress (with or without caching) diff --git a/docs/getting-started/installation-guide.md b/docs/getting-started/installation-guide.md index 1e585eb3..ba483cff 100644 --- a/docs/getting-started/installation-guide.md +++ b/docs/getting-started/installation-guide.md @@ -4,15 +4,15 @@ ![wordops-install](https://netdata.wordops.eu/netdata/api/v1/badge.svg?chart=web_log_wops.cc.requests_per_url&options=unaligned&dimensions=download&group=sum&after=-86400&label=today&units=installations&precision=0) -We provide an installer script which install the required dependencies, before setting-up WordOps. It can be installed with the following command : +We provide an installer script which install the required dependencies, before setting-up WordOps. It can be installed with the following command: ```bash wget -qO wo wops.cc && sudo bash wo ``` -Options : +Options: -- `-w` | `--wufw` | `--without-ufw` : do not configure UFW during setup +- `-w` | `--wufw` | `--without-ufw`: do not configure UFW during setup ??? Info "What are the tasks performed by the install script ?" - Installing WordOps dependencies @@ -27,7 +27,7 @@ Options : - Adding systemd service to apply kernel settings on boot (for Netdata & Redis) - Configuring UFW with minimal rules for WordOps -### Alternative : Clone Github repository and run +### Alternative: Clone Github repository and run ```bash git clone https://github.com/WordOps/WordOps.git diff --git a/docs/getting-started/post-install-steps.md b/docs/getting-started/post-install-steps.md index 167e44f8..5f711685 100644 --- a/docs/getting-started/post-install-steps.md +++ b/docs/getting-started/post-install-steps.md @@ -4,7 +4,7 @@ These are the first steps **after** you install WordOps. If you haven't installe ## Enable bash_completion -To enable WordOps commands auto-completion, run the following command after WordOps installation : +To enable WordOps commands auto-completion, run the following command after WordOps installation: ```bash source /etc/bash_completion.d/wo_auto.rc @@ -44,4 +44,4 @@ Here the list of WordOps components installed with the above command - APT package are debian packages installed from APT repositories - Binaries are simple executables -- Web App are php based applications +- Web App are PHP based applications diff --git a/docs/getting-started/prerequesites.md b/docs/getting-started/prerequesites.md index d70b0ee3..57432c1d 100644 --- a/docs/getting-started/prerequesites.md +++ b/docs/getting-started/prerequesites.md @@ -4,14 +4,14 @@ ### Minimum -WordOps is very lightweight, it doesn't require a lot of resources and can be installed on low end devices like Raspberry PI. Minimum requirements are : +WordOps is very lightweight, it doesn't require a lot of resources and can be installed on low end devices like Raspberry PI. Minimum requirements are: - ~100MB of storage - 512MB RAM ### Recommended -However, if you are going to use WordOps in production, some services like MySQL or Redis may need more resources, and running WordOps stacks without enough resources could impact your sites performance. Resources usage also highly depend on your site traffic. Here our recommended hardware configuration for production : +However, if you are going to use WordOps in production, some services like MySQL or Redis may need more resources, and running WordOps stacks without enough resources could impact your sites performance. Resources usage also highly depend on your site traffic. Here our recommended hardware configuration for production: - Multi-core CPU - 20GB SSD storage diff --git a/docs/guides.md b/docs/guides.md index 7be80719..8ad60611 100644 --- a/docs/guides.md +++ b/docs/guides.md @@ -1,6 +1,6 @@ # Guides & Tutorials -Here a list of guides and tutorials about WordOps : +Here a list of guides and tutorials about WordOps: - [Migration from EasyEngine v3](guides/migration-from-easyengine.md) - [Issue and manage ssl certificates](guides/manage-ssl-certificates.md) diff --git a/docs/guides/manage-ssl-certificates.md b/docs/guides/manage-ssl-certificates.md index 494c75f7..4e7679e9 100644 --- a/docs/guides/manage-ssl-certificates.md +++ b/docs/guides/manage-ssl-certificates.md @@ -2,7 +2,7 @@ In this guide, we will explain how to issue a Let's Encrypt SSL certificate to secure your site and the different options available. -To issue a SSL certificate with WordOps, you can use the following arguments with the commands : +To issue a SSL certificate with WordOps, you can use the following arguments with the commands: - `wo site create` - `wo site update` @@ -10,7 +10,7 @@ To issue a SSL certificate with WordOps, you can use the following arguments wit | options | description | | --------------------------- | --------------------------------------------------------------------------------- | | `--letsencrypt` / `-le` | issue a SSL certificate for domain or subdomain | -| `--letsencrypt=wildcard` | issue a wildcard SSL certificate : **domain.tld + \*.domain.tld** | +| `--letsencrypt=wildcard` | issue a wildcard SSL certificate: **domain.tld + \*.domain.tld** | | `--dns` / `--dns=` | use DNS API validation for Acme challenge. **required for wildcard certificates** | `-le` is an alias for `--letsencrypt`. You can use this alias with all letsencrypt commands. @@ -25,13 +25,13 @@ By default WordOps use the Webroot mode to validate the domain. This mode doesn' #### domain + www.domain.tld -To create a new site : +To create a new site: ```bash wo site create site.tld --wp -le ``` -To secure an existant site : +To secure an existant site: ```bash wo site update site.tld -le @@ -39,13 +39,13 @@ wo site update site.tld -le #### sub-domain -To create a new site : +To create a new site: ```bash wo site create sub.site.tld --wp -le ``` -To secure an existant site : +To secure an existant site: ```bash wo site update sub.site.tld -le @@ -58,7 +58,7 @@ wo site update sub.site.tld -le #### domain or subdomain -To create a new site with Cloudflare DNS API : +To create a new site with Cloudflare DNS API: ```bash wo site create site.tld --wp -le --dns=dns_cf @@ -72,7 +72,7 @@ wo site update sub.site.tld -le --dns=dns_do #### wildcard -To create a new site with Cloudflare DNS API : +To create a new site with Cloudflare DNS API: ```bash wo site create site.tld --wp --letsencrypt=wildcard --dns=dns_cf diff --git a/docs/guides/migration-from-easyengine.md b/docs/guides/migration-from-easyengine.md index 7533ef79..673e4ccf 100644 --- a/docs/guides/migration-from-easyengine.md +++ b/docs/guides/migration-from-easyengine.md @@ -2,7 +2,7 @@ ## Running WordOps install script -The first step to migrate from EasyEngine to WordOps is to run WordOps install script with the command : +The first step to migrate from EasyEngine to WordOps is to run WordOps install script with the command: ```bash wget -qO wo wops.cc && sudo bash wo @@ -22,7 +22,7 @@ After installing WordOps, if all your sites are still working properly, you can ### Updating site configuration -You have the choice between two method to update your site configuration : +You have the choice between two method to update your site configuration: - With the command `wo site update` (recommended) @@ -30,7 +30,7 @@ You have the choice between two method to update your site configuration : #### Using the command `wo site update` -The easiest way to update your site with the new WordOps configurations is to use the command : +The easiest way to update your site with the new WordOps configurations is to use the command: ```bash wo site update site.tld @@ -39,7 +39,7 @@ wo site update site.tld To update your sites configuration, you can enable PHP 7.3 on your site with the argument `--php73` and then disable it with the argument `--php73=off` to use PHP 7.2. This will regenerate your site Nginx vhost and apply the new configuration. -**Example** : +**Example**: ```bash # enable PHP 7.3 to regenerate site configuration @@ -50,7 +50,7 @@ wo site update site.tld --php73=off #### Manually editing site configuration -You can edit sites configuration with the command : +You can edit sites configuration with the command: ```bash wo site edit site.tld @@ -70,7 +70,7 @@ To use new WordOps configuration, you just have to replace the path of the confi For all WordPress related configuration files like `wpsc.conf` or `wpfc-php7.conf`, new configurations files are just named `wpsc-php72.conf` or `wpfc-php72.conf`. -There are some exceptions, list here : +There are some exceptions, list here: | **Previous configuration** | **New configuration** | | -------------------------- | ------------------------ | @@ -81,7 +81,7 @@ There are some exceptions, list here : ### Removing previous PHP version -If you do not need php5.6 and php7.0 anymore, you can safely remove them with the following commands : +If you do not need php5.6 and php7.0 anymore, you can safely remove them with the following commands: ```bash # php5.6 @@ -98,14 +98,14 @@ apt-get -y autoremove php7.0-fpm php7.0-common --purge #### Backup your databases -You can backup your MySQL databases with this simple bash script : +You can backup your MySQL databases with this simple bash script: ```bash wget https://raw.githubusercontent.com/VirtuBox/bash-scripts/master/backup/mysqldump/mysqldump.sh -O mysqldump.sh chmod +x mysqldump.sh ``` -Then perform a full backup : +Then perform a full backup: ```bash ./mysqldump.sh --full @@ -113,7 +113,7 @@ Then perform a full backup : This will backup the whole MySQL server and store the gzipped dump in /var/www/mysqldump -Additionally you can make a copy of the `/var/lib/mysql` directory : +Additionally you can make a copy of the `/var/lib/mysql` directory: ```bash sudo service mysql stop @@ -123,13 +123,13 @@ sudo service mysql start #### Upgrading MariaDB -At first, you need to remove the current MariaDB-server installed. To do so, use the command : +At first, you need to remove the current MariaDB-server installed. To do so, use the command: ```bash sudo apt-get autoremove mariadb-server -y ``` -Then you can reinstall the latest MariaDB-server version with WordOps : +Then you can reinstall the latest MariaDB-server version with WordOps: ```bash wo stack install --mysql diff --git a/docs/how-to.md b/docs/how-to.md index eac5e38f..37f4847e 100644 --- a/docs/how-to.md +++ b/docs/how-to.md @@ -12,7 +12,7 @@ #### Get a list of WordOps commands -To get the list of WordOps commands, you can use the command : +To get the list of WordOps commands, you can use the command: ```bash wo @@ -32,7 +32,7 @@ MySQL root password is stored in the file `/etc/mysql/conf.d/my.cnf` #### Display MySQL user and password of a site -You can use the command : +You can use the command: ```bash wo site info site.tld @@ -42,7 +42,7 @@ wo site info site.tld #### Access WordOps backend -WordOps backend is available on port 22222, you can access it with the server IP, hostname or with a domain pointed to the server IP : +WordOps backend is available on port 22222, you can access it with the server IP, hostname or with a domain pointed to the server IP: ```bash # with server IP @@ -57,7 +57,7 @@ https://site.tld:22222 #### Change WordOps backend username and password -You can use the command : +You can use the command: ```bash wo secure --auth @@ -71,7 +71,7 @@ Previously with EasyEngine v3, Let's Encrypt certificates were renewed by runnin You may have noticed the command `site update --le=renew` still exist in WordOps, but you shouln't need it because WordOps use the awesome acme client acme.sh to issue and handle Let's Encrypt SSL certificates. All certificates are **automatically renewed every 60 days** by acme.sh using a cronjob. -However, if you really need to renew your certificates, you can directly use acme.sh to renew all certificates with the following command : +However, if you really need to renew your certificates, you can directly use acme.sh to renew all certificates with the following command: ```bash acme.sh --renew-all --ecc diff --git a/docs/how-to/configure-letsencrypt-dns-api-validation.md b/docs/how-to/configure-letsencrypt-dns-api-validation.md index 0209590e..6d5d5406 100644 --- a/docs/how-to/configure-letsencrypt-dns-api-validation.md +++ b/docs/how-to/configure-letsencrypt-dns-api-validation.md @@ -15,34 +15,34 @@ In this example, we will configure Cloudflare DNS API, but configuration will be !!! info DNS providers list and configurations are available in [acme.sh wiki](https://github.com/Neilpang/acme.sh/wiki/dnsapi) -### Step 1 : get your API credentials +### Step 1: get your API credentials -Requirements : +Requirements: - your Cloudflare account email address - your Global API Key available in your [Cloudflare profile](https://dash.cloudflare.com/profile) -### Step 2 : set your credentials with acme.sh variables +### Step 2: set your credentials with acme.sh variables -Before issuing your first SSL certificate with DNS API, you have to define your API credentials with the command `export` : +Before issuing your first SSL certificate with DNS API, you have to define your API credentials with the command `export` : -Example for Cloudflare : +Example for Cloudflare: ```bash export CF_Key="sdfsdfsdfljlbjkljlkjsdfoiwje" export CF_Email="xxxx@sss.com" ``` -- CF_Key : Cloudflare Global API key available in your [Cloudflare profile](https://dash.cloudflare.com/profile) -- CF_Email : Your Cloudflare account email address +- CF_Key: Cloudflare Global API key available in your [Cloudflare profile](https://dash.cloudflare.com/profile) +- CF_Email: Your Cloudflare account email address -Example with DigitalOcean : +Example with DigitalOcean: ```bash export DO_API_KEY="75310dc4ca779ac39a19f6355db573b49ce92ae126553ebd61ac3a3ae34834cc" ``` -Example with GoDaddy : +Example with GoDaddy: ```bash export GD_Key="sdfsdfsdfljlbjkljlkjsdfoiwje" @@ -52,7 +52,7 @@ export GD_Secret="asdfsdafdsfdsfdsfdsfdsafd" !!! info DNS providers list and configurations are available in [Acme.sh Wiki](https://github.com/Neilpang/acme.sh/wiki/dnsapi) -### Step 3 : issue your certificate +### Step 3: issue your certificate For a new site secured with a wildcard SSL certificates with Cloudflare DNS API @@ -60,8 +60,8 @@ For a new site secured with a wildcard SSL certificates with Cloudflare DNS API wo site create site.tld --wp --letsencrypt=wildcard --dns=dns_cf ``` -- `--letsencrypt=wildcard` : issue a wildcard certificate `domain.tld` + `*.domain.tld` -- `--dns=dns_cf` : enable DNS API mode with Cloudflare. +- `--letsencrypt=wildcard`: issue a wildcard certificate `domain.tld` + `*.domain.tld` +- `--dns=dns_cf`: enable DNS API mode with Cloudflare. For an existant secured with a simple SSL certificate (site + www.site.tld) with DigitalOcean DNS API @@ -69,8 +69,8 @@ For an existant secured with a simple SSL certificate (site + www.site.tld) with wo site update site.tld -le --dns=dns_do ``` -- `-le` : issue a certificate for `domain.tld` + `www.domain.tld` -- `--dns=dns_do` : enable DNS API mode with DigitalOcean +- `-le`: issue a certificate for `domain.tld` + `www.domain.tld` +- `--dns=dns_do`: enable DNS API mode with DigitalOcean ## Informations diff --git a/docs/how-to/configure-ufw-firewall.md b/docs/how-to/configure-ufw-firewall.md index fdbc9516..b7ed2d02 100644 --- a/docs/how-to/configure-ufw-firewall.md +++ b/docs/how-to/configure-ufw-firewall.md @@ -41,7 +41,7 @@ sudo ufw allow 21 sudo ufw allow 49000:50000/tcp ``` -You can check what ports are currently used on your server with the following command : +You can check what ports are currently used on your server with the following command: ```bash sudo netstat -tulpn diff --git a/docs/how-to/get-a-plus-grade-ssllabs.md b/docs/how-to/get-a-plus-grade-ssllabs.md index 5b668aa2..a50c0142 100644 --- a/docs/how-to/get-a-plus-grade-ssllabs.md +++ b/docs/how-to/get-a-plus-grade-ssllabs.md @@ -55,7 +55,7 @@ Congratulations, you can now check your grade on https://www.ssllabs.com/ssltest ### Switching HSTS off -It's not recommended to disable HSTS because web browser will store the HSTS directive for a long time (6 months) and will not allow access over HTTP even after disabling HSTS on the server. However, if you absolutely need to disable HSTS, you can use the following command : +It's not recommended to disable HSTS because web browser will store the HSTS directive for a long time (6 months) and will not allow access over HTTP even after disabling HSTS on the server. However, if you absolutely need to disable HSTS, you can use the following command: ```bash wo site update site.tld --hsts=off diff --git a/docs/how-to/secure-22222.md b/docs/how-to/secure-22222.md index 3003dedd..039d3b87 100644 --- a/docs/how-to/secure-22222.md +++ b/docs/how-to/secure-22222.md @@ -13,7 +13,7 @@ DOMAIN_NAME=site.ltd sudo grep "ssl_" /var/www/${DOMAIN_NAME}/conf/nginx/ssl.conf > /var/www/22222/conf/nginx/ssl.conf ``` -Then reload Nginx : +Then reload Nginx: ```bash wo stack restart --nginx @@ -23,9 +23,9 @@ You should now be able to access to WordOps backend on `https://site.tld:22222` ### Issue a new certificate to secure WordOps backend -If you prefer to issue manually a new Let's Encrypt SSL certificate, here the steps to follow : +If you prefer to issue manually a new Let's Encrypt SSL certificate, here the steps to follow: -Set your domain or subdomain as a variable : +Set your domain or subdomain as a variable: ```bash DOMAIN_NAME=backend.site.ltd diff --git a/docs/security/recommendations.md b/docs/security/recommendations.md index d77322e9..3adb0ca1 100644 --- a/docs/security/recommendations.md +++ b/docs/security/recommendations.md @@ -4,7 +4,7 @@ In this section, you will find few guides/tutorials about server security and wh ## Enable automatic installation of security upgrades -Debian and Ubuntu provide an automated security upgrades service with the package automatic installation of security upgrades unattended-upgrades. You can enable automatic installation of security upgrades with the command : +Debian and Ubuntu provide an automated security upgrades service with the package automatic installation of security upgrades unattended-upgrades. You can enable automatic installation of security upgrades with the command: ```bash sudo dpkg-reconfigure -plow unattended-upgrades diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index d73cf322..b14609ee 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -5,7 +5,7 @@ ### The command `wo update` failed This is a known issue with WordOps v3.9.6 which has been fixed with the maintenance release v3.9.6.1. -As a workaround you can either use the command `wo update --beta` or run again the install command : +As a workaround you can either use the command `wo update --beta` or run again the install command: ```bash wget -qO wo wops.cc && sudo bash wo @@ -15,12 +15,12 @@ wget -qO wo wops.cc && sudo bash wo ### WordOps failed to issue SSL certificate -At first, make sure your domain is pointed to your server IP : +At first, make sure your domain is pointed to your server IP: - www.site.tld + site.tld if you use the flag `-le` or `--letsencrypt` - sub.site.tld if you use the flag `-le=subdomain` or `--letsencrypt=subdomain` -Then if you need to cleanup the previous SSL certificate, you can use the following command to remove existant certificates and keys, as well as other Nginx configurations for your domain : +Then if you need to cleanup the previous SSL certificate, you can use the following command to remove existant certificates and keys, as well as other Nginx configurations for your domain: ```bash wo site update site.tld --letsencrypt=clean @@ -30,7 +30,7 @@ wo site update site.tld --letsencrypt=clean This issue seems to be related to brotli but, but even after investigation, we haven't be able to find the cause of this issue yet. -You can disable brotli compression by running the following command : +You can disable brotli compression by running the following command: ```bash sudo sed -i 's/brotli on;/brotli off;/' /etc/nginx/nginx.conf @@ -40,13 +40,13 @@ sudo nginx -t && sudo service nginx restart ### When I update a page, changes are not applied on the site -If you are using Nginx fastcgi_cache, please make sure : +If you are using Nginx fastcgi_cache, please make sure: - Nginx-helper plugin is enabled - the option "purge cache" is enabled in Settings > Nginx-Helper - the caching method is defined on Nginx Fastcgi cache -If you are using Redis-cache, please make sure : +If you are using Redis-cache, please make sure: - Nginx-helper plugin is enabled - the option "purge cache" is enabled in Settings > Nginx-Helper @@ -55,7 +55,7 @@ If you are using Redis-cache, please make sure : ### WordOps commands are not working -If the error output looks like : +If the error output looks like: ```bash Traceback (most recent call last): @@ -76,7 +76,7 @@ Traceback (most recent call last): pkg_resources.DistributionNotFound: The 'wo==3.9.8.2' distribution was not found and is required by the application ``` -Just remove the executable `/usr/local/bin/wo` and reinstall WordOps : +Just remove the executable `/usr/local/bin/wo` and reinstall WordOps: ```bash sudo rm /usr/local/bin/wo && wget -qO wo wops.cc && sudo bash wo