A starter repository for WordPress websites for organisers, campaigns and anyone else who finds it useful.
This folder structure uses the Bedrock pattern, a modern WordPress stack.
- 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>
- Generate a repository from this template
- If you have PHP and Composer installed locally you can run from this directory
composer install
. Otherwise runcomposer install
via Docker withdocker compose run composer install
. - Copy
.env.example
to.env
, runningcp .env.example .env
. The example file contains variables required for this Docker Compose setup but modify details appropriately as per the Bedrock documentation as required. - Start up all containers with:
docker compose up
- You can access the site at http://localhost:8082. You can install WordPress automatically by running
docker compose run wordpress wp core install --url=http://localhost:8082 --title='WordPress Starter Template' --admin_user=ck_admin --admin_email=hello@commonknowledge.coop
.
This template comes with some useful development tools for use within WordPress itself.
Crucial. Save off block themes that you are making in the full site editor to the theme on disk. Add fonts direct from the WordPress backend, including Google Fonts.
Create WordPress patterns from within the WordPress backend. They are automatically saved to the theme on disk, with appropriate metadata and can also be modified in this way.
Generate a lot of dummy content to see how the website looks and feels with full content in it.
Again for creating dummy data, this allows quick duplication of posts to fill things out.
- Run
composer outdated
to verify any dependencies that require updating. - Run
composer bump
to bump minor versions and save results tocomposer.json
. - Update within
composer.json
. For example thewordpress
package. - Run
composer update
. - Commit the result.
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.
Run docker compose run composer require wpackagist-plugin/plugin-name
.
Documentation for Bedrock is available at https://roots.io/bedrock/docs/.
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.
- 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.
- 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.
- 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.
- 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.
- 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
- Add you GitHub SSH key to
ssh-agent
following these instructions. The command will be something likessh-add ~/.ssh/gitlab_key_rsa
- We are going to begin with the staging environment. SSH onto Kinsta staging environment using this command
ssh nurses_united_staging
. - Test GitHub works by running the command
ssh -T git@github.com
. After accepting the authenticity of the host you should see a friendly message from GitHub. - Remove the
public
directory withrm -r public
. Clone the code into thepublic/
directiory:git clone git@github.com:commonknowledge/pluto-press.git public
. cd public && composer install
. 11 Return to thepublic
directory,cd ~/public
. If this is the first time, copy.env.example
to.env
withcp .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". TheWP_HOME
can behttp://localhost
.- 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 email>
. This will output the password for the user you have just created to the terminal. Save it for when you need to login. - Ask Kinsta to update NGINX to point at
public/web
on Intercom chat inside the Kinsta control panel. Note, notpublic/current/web
, which is the directory if you are deploy Bedrock with Trellis. This installation does not use Trellis. - You can now point the domains to this installation of WordPress following Kinsta's instructions.
- 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.
- 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 haveWP_HOME
includehttps
nothttp
. - In Domains, change the DNS pointed domain to your primary one selecting "Make primary".
- WordPress should now work at the site URL. You can login to the administration dashboard with the password you just created.
- Repeat steps 7 through 20, but creating a development environment.