Platform WordPress Site

A WordPress project based off the Common Knowledge WordPress Starter.

This folder structure uses the Bedrock pattern, a modern WordPress stack.

Requirements

• Docker installed
• PHP and Composer installed locally. If not, you can use them in containers provided, prefixing all Composer commands below with docker compose run composer <command>

Run locally

1. Copy .env.example to .env. There should be no need to change this file.
2. Start the docker containers with docker compose up -d.
3. Wait for the mysql container to be running (check with docker compose logs -f mysql) then import the seed SQL: mysql -uroot -ppassword -P 3308 < platform.sql
4. Install JS/CSS requirements: cd web/app/themes; npm i
5. While still in the theme directory, start the CSS processor: npm run watch
6. The site should now be up at http://localhost:8082.
7. The admin system is at http://localhost:8082/wp/wp-admin and the default login/password is admin/admin.

Full development documentation

Updating WordPress

1. Update WordPress in the composer.json file by increasing the version on the roots/wordpress-no-content line.
2. Run composer update roots/wordpress. This will update the composer.lock file as needed.
3. Push the change to GitHub.

WP-CLI

WP-CLI is installed in the wordpress container.

docker compose run wordpress wp --allow-root <command>

Note WP-CLI will not work on the host machine, as WordPress configuration refers to databases within the Docker network, not the host machine.

Adding WordPress Plugins

Run docker compose run composer require wpackagist-plugin/plugin-name.

Further Documentation

Documentation for Bedrock is available at https://roots.io/bedrock/docs/.

Hosting

Using Kinsta

The following are instructions on how to setup a new site on Kinsta.

You will need to have "Company developer" or above permissions in order to create a site.

These are exhaustive manual instructions, but should not be required after initial setup.

1. Create a new site on Kinsta. You want to select "Don't install WordPress" and choose the London data centre. It will provision after around ten minutes.
2. On Kinsta we have a Live environment and a staging environment. Start with the Live environment for a new build. Then after, you can create a staging environment as needed.
3. For the next steps, you will need to add your SSH key to Kinsta. This is to allow you to log into Kinsta over SSH.
4. You will also need to add a SSH key to GitHub. This is so you can check out the theme from GitHub over SSH when logged into Kinsta.
5. Kinsta needs to be set up to forward you GitHub SSH key to it when you connect to it over SSH and checkout the theme with Git. You can look up the precise SSH details on Kinsta under the "SFTP/SSH" in the live environment section of the admin panel. You can then add them to a ~/.ssh/config block to look something like this.

    host <your site>_live
        User <see "SFTP/SSH" details for Live Environment>
        Hostname <see "SFTP/SSH" details for Live Environment>
        Port <see "SFTP/SSH" details for Live Environment>
        IdentityFile <Location on your local machine of the SSH key>
        ForwardAgent yes
   

6. Add you GitHub SSH key to ssh-agent following these instructions. The command will be something like ssh-add ~/.ssh/gitlab_key_rsa
7. We are going to begin with the staging environment. SSH onto Kinsta staging environment using this command ssh nurses_united_staging.
8. Test GitHub works by running the command ssh -T [email protected]. After accepting the authenticity of the host you should see a friendly message from GitHub.
9. Remove the public directory with rm -r public. Clone the code into the public/ directiory: git clone [email protected]:commonknowledge/pluto-press.git public.
10. cd public && composer install. 11 Return to the public directory, cd ~/public. If this is the first time, copy .env.example to .env with cp .env.example .env and modify details appropriately as per the Bedrock documentation. You can use Vim on the server. The details of the database are on the Kinsta admin panel under the site itself then "Database Access". The WP_HOME can be http://localhost.
11. You need to create database tables for WordPress. Run wp core install --url=<URL from Primary domain in Kinsta admin panel> --title=<site name> --admin_user=<desired username> --admin_email=<desired password>. This will output the password for the user you have just created to the terminal. Save it for when you need to login.
12. Ask Kinsta to update NGINX to point at public/web on Intercom chat inside the Kinsta control panel. Note, not public/current/web, which is the directory if you are deploy Bedrock with Trellis. This installation does not use Trellis.
13. You can now point the domains to this installation of WordPress following Kinsta's instructions.
14. Head to Tools for the site in the live environment. Use "SSL certificate" to generate a new Let's Encrypt SSL certificate and wait for this to complete.
15. Still on the tools page, setup Force HTTPS by clicking on Modify and dollowing your nose, selecting "Force all traffic to the primary domain" along the way. Edit the .env file created in step 12, to have WP_HOME include https not http.
16. In Domains, change the DNS pointed domain to your primary one selecting "Make primary".
17. WordPress should now work at the site URL. You can login to the administration dashboard with the password you just created.
18. Repeat steps 7 through 20, but creating a development environment.