Shifter (Static) - Local

Docker image for testing WordPress themes and plugins while migrating to Shifter. This image is also available on Dockerhub.

Limitations

Shifter-Local is released for the purpose of only checking the operation of WordPress theme and plug-in in Shifter platform.

The following features, combined with the Shifter platform. do not work on Shifter-Local.

• All Shifter menus in WordPress dashboard
• Terminate, Generate, or etc...
• Passwordless login

Currently only environments capable of running linux/arm64 platforms are supported due to build reasons. As soon as the problem is resolved, we will provide linux/amd64, and linux/arm64.

Getting Started

Install Docker Desktop

git clone https://github.com/digitalcube/shifter-static-local.git my-shifter-site

cd my-shifter-site

docker-compose up

or

npm run start

Experimental

Testing "Create Shifter Site" (Similar to Create React App npx create-react-app)

Step 1:

git clone --branch feature/scripts https://github.com/digitalcube/shifter-static-local my-shifter-site

Step 2:

cd my-shifter-site

Step 3:

npm run start

Visit https://127.0.0.1:8443 in your browser.

Use Ctl + C in your terminal window to stop running containers.

to run in the background, use -d option.

docker-compose up -d

Apple Silicon

Docker Desktop for Apple Silicon

Using the docker-compose.yml config file.

docker-compose -f docker-compose.yml

Linux

Considering file permissions, we recommend using volumes on Linux.

docker-compose -f docker-compose.yml -f docker-compose_linux.yml up

Updating Docker Image

docker-compose pull

You can use any tag from the following provided.

• latest: Similar as Shifter production environment.

NPM Scripts

NPM scripts are also available.

npm run start     # Starts site
npm run stop      # Stops site
npm run clean     # Deletes Docker data
npm run reset     # Deletes all data

Storage

• MacOS
  • ./volume/app: wordpress/wp-content files
  • ./volume/db: mysql databases
• Linux (detect path using docker volume inspect)
  • /var/lib/docker/volumes/shifterlocal_app/_data: wordpress/wp-content files
  • /var/lib/docker/volumes/shifterlocal_db/_data: mysql databases

All data will be persisted in these directories, even if the Docker containers are stopped.

To start over with the installation, simply run make clean.

Upgrade mysql 5.6 to 5.7

The included mysql version has been changed from 5.6 to 5.7. If you want to keep the data, you can upgrade after starting docker-compose with the following command.

$ make mysql_upgrade

Debugging

Some plugins and themes may conflict with Shifter. Conflicts usually cause the Generator to hang or fail. Here are a few tips.

Check for a valid JSON format

Your site should return a list of valid URLs in JSON format for Shifter to crawl for generating.

Add ?url=0 to the websites URL to test.

https://127.0.0.1:8443?urls=0

Check for list of all target pages

If the number of pages to be generated is more than 100, you can check the target by 100 pages by increasing the number of the urls parameter. (e.g. urls=1, urls=2)

Pages that do not appear in this list are not subject to generate.

Common problems and solutions when there are no pages in the list are as follows.

• pagination issues. (Work in progress)

Displaying PHP Errors

While running your site on Shifters production environment PHP warning are suppressed. These warning if any are visible while running Shifter-Local for debugging your theme.

Work in subdirectory

To use WordPress like subdirectory installation, follow the steps below.

• open docker-compose.yml to edit
• remove # from SITE_SUBDIR line and set subdirectory name

Run WP-CLI in Container

$ docker-compose exec --workdir /var/www/html/web/wp --user www-data wp /usr/local/bin/wp --version
WP-CLI 2.4.0

Example: force update user password

$ docker-compose exec --workdir /var/www/html/web/wp --user www-data wp /usr/local/bin/wp user update 1 --user_pass=TYPE-NEW-PASSWORD

Success: Updated user 1.

Example: force update Core to Release Candidate

$ docker-compose exec --workdir /var/www/html/web/wp --user www-data wp /usr/local/bin/wp core update --version=5.7-RC2

Success: WordPress updated successfully.

Considerations

• Depending on your local environment mail functions may send from this container. Example: Under Outbound Port 25 Blocking

Disclaimer

This Docker image is similar to the one used by Shifter, but does not guarantee complete compatibility.