├── .circleci └── config.yml ├── .gitignore ├── LICENSE ├── Makefile ├── README.md ├── docker-compose.ci.yml ├── docker-compose.yml ├── docker-compose_arm64.yml ├── docker-compose_linux.yml ├── mysql.append.cnf └── package.json /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: 2.1 2 | orbs: 3 | slack: circleci/slack@3.4 4 | docker: circleci/docker@2.6 5 | 6 | jobs: 7 | build: 8 | machine: 9 | image: ubuntu-2204:current 10 | resource_class: arm.medium 11 | # docker: 12 | # - image: cimg/base:current 13 | # auth: 14 | # username: $DOCKERHUB_USERNAME 15 | # password: $DOCKERHUB_PASSWORD 16 | steps: 17 | - checkout 18 | - docker/install-docker-compose 19 | # - setup_remote_docker 20 | - run: 21 | name: Start container and verify it's working 22 | command: | 23 | set -x 24 | docker-compose -f docker-compose.ci.yml up -d 25 | sleep 60 26 | docker-compose -f docker-compose.ci.yml exec wp curl -ksfI --retry 20 --retry-delay 5 --retry-connrefused https://127.0.0.1/wp-admin/install.php 27 | - slack/status: 28 | fail_only: true 29 | 30 | workflows: 31 | version: 2 32 | default: 33 | jobs: 34 | - build: 35 | context: 36 | - docker-hub-gsd 37 | daily: 38 | jobs: 39 | - build: 40 | context: 41 | - docker-hub-gsd 42 | triggers: 43 | - schedule: 44 | cron: "55 4 * * *" 45 | filters: 46 | branches: 47 | only: 48 | - main 49 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /volume/ 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [2018] [Shifter Developer Team] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: noop mysql_upgrade clean 2 | 3 | noop: 4 | @echo 5 | 6 | clean: 7 | docker-compose stop 8 | docker-compose rm -f 9 | docker volume prune -f 10 | rm -rf volume/* 11 | 12 | mysql_upgrade: 13 | docker-compose exec mysql mysql_upgrade 14 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Shifter (Static) - Local 2 | 3 | [![CircleCI](https://circleci.com/gh/digitalcube/shifter-static-local/tree/main.svg?style=svg)](https://circleci.com/gh/getshifter/shifter-local/tree/main) 4 | 5 | [![shifter_local](http://dockeri.co/image/getshifter/shifter_local)](https://hub.docker.com/r/getshifter/shifter_local/) 6 | 7 | Docker image for testing WordPress themes and plugins while migrating to Shifter. This image is also available on [Dockerhub](https://hub.docker.com/r/getshifter/shifter_local/). 8 | 9 | ## Limitations 10 | 11 | Shifter-Local is released for the purpose of only checking the operation of WordPress theme and plug-in in Shifter platform. 12 | 13 | The following features, combined with the Shifter platform. do not work on Shifter-Local. 14 | 15 | - All Shifter menus in WordPress dashboard 16 | - Terminate, Generate, or etc... 17 | - Passwordless login 18 | 19 | > Currently only environments capable of running `linux/arm64` platforms are supported due to build reasons. 20 | > As soon as the problem is resolved, we will provide `linux/amd64`, and `linux/arm64`. 21 | 22 | ## Getting Started 23 | 24 | [Install Docker Desktop](https://www.docker.com/products/docker-desktop) 25 | 26 | ``` 27 | git clone https://github.com/digitalcube/shifter-static-local.git my-shifter-site 28 | ``` 29 | 30 | ``` 31 | cd my-shifter-site 32 | ``` 33 | 34 | ``` 35 | docker-compose up 36 | 37 | or 38 | 39 | npm run start 40 | ``` 41 | 42 | ### Experimental 43 | 44 | Testing "Create Shifter Site" (Similar to Create React App npx create-react-app) 45 | 46 | Step 1: 47 | 48 | ``` 49 | git clone --branch feature/scripts https://github.com/digitalcube/shifter-static-local my-shifter-site 50 | ``` 51 | 52 | Step 2: 53 | 54 | ``` 55 | cd my-shifter-site 56 | ``` 57 | 58 | Step 3: 59 | 60 | ``` 61 | npm run start 62 | ``` 63 | 64 | Visit [https://127.0.0.1:8443](https://127.0.0.1:8443) in your browser. 65 | 66 | Use `Ctl + C` in your terminal window to stop running containers. 67 | 68 | to run in the background, use `-d` option. 69 | 70 | ``` 71 | docker-compose up -d 72 | ``` 73 | 74 | ### Apple Silicon 75 | 76 | [Docker Desktop for Apple Silicon](https://docs.docker.com/desktop/mac/apple-silicon/) 77 | 78 | Using the docker-compose.yml config file. 79 | 80 | ``` 81 | docker-compose -f docker-compose.yml 82 | ``` 83 | 84 | ### Linux 85 | 86 | Considering file permissions, we recommend using volumes on Linux. 87 | 88 | ``` 89 | docker-compose -f docker-compose.yml -f docker-compose_linux.yml up 90 | ``` 91 | 92 | ### Updating Docker Image 93 | 94 | ``` 95 | docker-compose pull 96 | ``` 97 | 98 | You can use any tag from the following provided. 99 | 100 | - `latest`: Similar as Shifter production environment. 101 | 102 | ### NPM Scripts 103 | 104 | NPM scripts are also available. 105 | 106 | ``` 107 | npm run start # Starts site 108 | npm run stop # Stops site 109 | npm run clean # Deletes Docker data 110 | npm run reset # Deletes all data 111 | ``` 112 | 113 | ### Storage 114 | 115 | - MacOS 116 | - `./volume/app`: `wordpress/wp-content` files 117 | - `./volume/db`: `mysql` databases 118 | - Linux (detect path using `docker volume inspect`) 119 | - `/var/lib/docker/volumes/shifterlocal_app/_data`: `wordpress/wp-content` files 120 | - `/var/lib/docker/volumes/shifterlocal_db/_data`: `mysql` databases 121 | 122 | All data will be persisted in these directories, even if the Docker containers are stopped. 123 | 124 | To start over with the installation, simply run `make clean`. 125 | 126 | ### Upgrade mysql 5.6 to 5.7 127 | 128 | The included mysql version has been changed from 5.6 to 5.7. 129 | If you want to keep the data, you can upgrade after starting docker-compose with the following command. 130 | 131 | ``` 132 | $ make mysql_upgrade 133 | ``` 134 | 135 | ## Debugging 136 | 137 | Some plugins and themes may conflict with Shifter. Conflicts usually cause the Generator to hang or fail. Here are a few tips. 138 | 139 | ### Check for a valid JSON format 140 | 141 | Your site should return a list of valid URLs in JSON format for Shifter to crawl for generating. 142 | 143 | Add `?url=0` to the websites URL to test. 144 | 145 | [https://127.0.0.1:8443?urls=0](`https://127.0.0.1:8443?urls=0`) 146 | 147 | ### Check for list of all target pages 148 | 149 | 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) 150 | 151 | Pages that do not appear in this list are not subject to generate. 152 | 153 | Common problems and solutions when there are no pages in the list are as follows. 154 | 155 | - pagination issues. (Work in progress) 156 | 157 | ### Displaying PHP Errors 158 | 159 | While running your site on Shifters [production](https://go.getshifter.io) environment PHP warning are suppressed. These warning if any are visible while running Shifter-Local for debugging your theme. 160 | 161 | ### Work in subdirectory 162 | 163 | To use WordPress like subdirectory installation, follow the steps below. 164 | 165 | - open `docker-compose.yml` to edit 166 | - remove `#` from `SITE_SUBDIR` line and set subdirectory name 167 | 168 | ### Run WP-CLI in Container 169 | 170 | ``` 171 | $ docker-compose exec --workdir /var/www/html/web/wp --user www-data wp /usr/local/bin/wp --version 172 | WP-CLI 2.4.0 173 | ``` 174 | 175 | #### Example: force update user password 176 | 177 | ``` 178 | $ 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 179 | 180 | Success: Updated user 1. 181 | ``` 182 | 183 | #### Example: force update Core to Release Candidate 184 | 185 | ``` 186 | $ docker-compose exec --workdir /var/www/html/web/wp --user www-data wp /usr/local/bin/wp core update --version=5.7-RC2 187 | 188 | Success: WordPress updated successfully. 189 | ``` 190 | 191 | ## Considerations 192 | 193 | - Depending on your local environment mail functions may send from this container. Example: Under `Outbound Port 25 Blocking` 194 | 195 | ## Disclaimer 196 | 197 | This Docker image is similar to the one used by Shifter, but does not guarantee complete compatibility. 198 | -------------------------------------------------------------------------------- /docker-compose.ci.yml: -------------------------------------------------------------------------------- 1 | version: '3' 2 | services: 3 | wp: 4 | image: getshifter/shifter_local:latest 5 | platform: linux/arm64 6 | user: root 7 | links: 8 | - mysql 9 | ports: 10 | - 8443:443 11 | volumes: 12 | - "app:/var/www/html/web/wp/wp-content" 13 | environment: 14 | - SERVICE_PORT=8443 15 | # - SERVICE_DOMAIN=127.0.0.1 16 | - RDB_ENDPOINT=mysql:3306 17 | - RDB_USER=shifter 18 | - RDB_PASSWD=pass 19 | - SHIFTER_LOCAL=true 20 | # - SITE_SUBDIR=subdirpath # run /subdirpath 21 | # - SERVICE_TYPE=generator # to simulate generator environment 22 | mysql: 23 | image: mariadb:10.3 24 | platform: linux/arm64 25 | environment: 26 | - MARIADB_RANDOM_ROOT_PASSWORD=true 27 | - MARIADB_ALLOW_EMPTY_PASSWORD=true 28 | - MARIADB_USER=shifter 29 | - MARIADB_PASSWORD=pass 30 | - MARIADB_DATABASE=wordpress 31 | volumes: 32 | - "db:/var/lib/mysql" 33 | command: 34 | - --sql-mode=STRICT_TRANS_TABLES,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION 35 | 36 | volumes: 37 | app: 38 | db: 39 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3' 2 | services: 3 | wp: 4 | image: getshifter/shifter_local:latest 5 | platform: linux/arm64 6 | user: root 7 | links: 8 | - mysql 9 | ports: 10 | - 8443:443 11 | volumes: 12 | - "./volume/app:/var/www/html/web/wp/wp-content" 13 | environment: 14 | - SERVICE_PORT=8443 15 | # - SERVICE_DOMAIN=127.0.0.1 16 | - RDB_ENDPOINT=mysql:3306 17 | - RDB_USER=shifter 18 | - RDB_PASSWD=pass 19 | - SHIFTER_LOCAL=true 20 | # - SITE_SUBDIR=subdirpath # run /subdirpath 21 | # - SERVICE_TYPE=generator # to simulate generator environment 22 | mysql: 23 | image: mysql:5.7 24 | platform: linux/amd64 25 | environment: 26 | - MYSQL_ALLOW_EMPTY_PASSWORD=true 27 | - MYSQL_USER=shifter 28 | - MYSQL_PASSWORD=pass 29 | - MYSQL_DATABASE=wordpress 30 | volumes: 31 | - "./mysql.append.cnf:/etc/mysql/mysql.conf.d/mysql.append.cnf" 32 | - "./volume/db:/var/lib/mysql" 33 | command: 34 | - --sql-mode=STRICT_TRANS_TABLES,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION 35 | -------------------------------------------------------------------------------- /docker-compose_arm64.yml: -------------------------------------------------------------------------------- 1 | version: '3' 2 | services: 3 | mysql: 4 | platform: linux/x86_64 -------------------------------------------------------------------------------- /docker-compose_linux.yml: -------------------------------------------------------------------------------- 1 | version: '3' 2 | services: 3 | wp: 4 | volumes: 5 | - "app:/var/www/html/web/wp/wp-content" 6 | mysql: 7 | image: mysql:5.7 8 | platform: linux/amd64 9 | volumes: 10 | - "db:/var/lib/mysql" 11 | 12 | volumes: 13 | app: 14 | db: 15 | 16 | -------------------------------------------------------------------------------- /mysql.append.cnf: -------------------------------------------------------------------------------- 1 | [mysqld] 2 | innodb_file_format = Barracuda 3 | innodb_file_format_max = Barracuda 4 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "shifter-local", 3 | "version": "1.0.0", 4 | "description": "Docker image for testing WordPress themes and plugins while migrating to Shifter. This image is also available on [Docker Hub](https://hub.docker.com/r/getshifter/shifter-local/).", 5 | "main": "docker-compose.yml", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1", 8 | "start": "docker-compose up", 9 | "stop": "docker-compose down", 10 | "clean": "docker-compose rm", 11 | "reset": "docker-compose rm && rm -rf volume" 12 | }, 13 | "repository": { 14 | "type": "git", 15 | "url": "git+https://github.com/getshifter/shifter-local.git" 16 | }, 17 | "author": "", 18 | "license": "ISC", 19 | "bugs": { 20 | "url": "https://github.com/getshifter/shifter-local/issues" 21 | }, 22 | "homepage": "https://github.com/getshifter/shifter-local#readme" 23 | } --------------------------------------------------------------------------------