diff options
| -rw-r--r-- | .gitignore | 16 | ||||
| -rw-r--r-- | LICENSE.txt | 202 | ||||
| -rw-r--r-- | Makefile | 131 | ||||
| -rw-r--r-- | build/mailhog/Dockerfile | 29 | ||||
| -rw-r--r-- | build/web/Dockerfile | 7 | ||||
| -rw-r--r-- | db.env.sample | 4 | ||||
| -rw-r--r-- | docker-compose.yml | 42 | ||||
| -rw-r--r-- | dotenv.makefile.sample | 25 | ||||
| -rw-r--r-- | gitignore.sample | 19 | ||||
| -rw-r--r-- | html/.gitkeep | 0 | ||||
| -rw-r--r-- | misc/disable-really-simple-ssl.makefile | 9 | ||||
| -rw-r--r-- | misc/vaultpress.makefile | 16 | ||||
| -rw-r--r-- | sql/.gitkeep | 0 |
13 files changed, 500 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..06a9fbc --- /dev/null +++ b/.gitignore @@ -0,0 +1,16 @@ +/html/* +/sql/* +!.gitkeep +*.log +.rsync_exlude + +.DS_Store + +.env +.env.makefile +.db.env +.envrc +build-docker + +do-deploy +deploy-with-skipping-confirm diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..8682370 --- /dev/null +++ b/Makefile @@ -0,0 +1,131 @@ +HTML_DIR := html +SQL_DIR := sql +WP_CONFIG_FILENAME := wp-config.php + +DOCKER_COMPOSE_YML := docker-compose.yml +DOCKER_COMPOSE_UP_OPT := -d + +DOCKER_COMPOSE = docker-compose -f $(DOCKER_COMPOSE_YML) + +DOCKER := docker +SSH := ssh +TAR := tar +REMOTE_TAR := tar +PV := pv +PERL := perl +FIND := find +RSYNC := rsync + +MYSQLDUMP_OPT := --single-transaction --quick --skip-lock-tables --add-drop-table + +CLONE_EXCLUDE := +REMOTE_TAR_OPT := +RSYNC_OPT = -rltv --delete + +SYNC_PATH = wp-content/themes + +deploy-once-file = ./do-deploy +deploy-always-file = ./deploy-with-skipping-confirm +check-deploy = $(if $(wildcard $(deploy-once-file) $(deploy-always-file)),1) + +include .env.makefile +include .db.env + +REMOTE_TAR_OPT += $(addprefix --exclude=,$(CLONE_EXCLUDE)) + +# $(call exist-or-error,some-file) +define exist-or-error + $(if $(wildcard $1),,$(error no $1 variable)) +endef + +.PHONY: up +up: build-docker + $(DOCKER_COMPOSE) up $(DOCKER_COMPOSE_UP_OPT) + +.PHONY: down +down: + $(DOCKER_COMPOSE) down + +build-docker: BUILD_OPT := --build-arg WP_IMAGE_TAG=$(WP_IMAGE_TAG) +build-docker: build + $(DOCKER_COMPOSE) build $(BUILD_OPT) + touch $@ + +.PHONY: logs +logs: + $(DOCKER_COMPOSE) logs -f + +.PHONY: clone-to-local +clone-to-local: + $(SSH) $(SSH_REMOTE_HOST) -- $(REMOTE_TAR) -C $(REMOTE_DOCROOT_PATH) -cf - $(REMOTE_TAR_OPT) . \ + | $(PV) | $(TAR) -C $(HTML_DIR)/ -xf - + +.PHONY: guard-sync +guard-sync: +ifndef SSH_REMOTE_HOST + $(error SSH_REMOTE_HOST variable is not defined) +endif + +.PHONY: pull +pull: guard-sync + $(RSYNC) $(RSYNC_OPT) $(SSH_REMOTE_HOST):$(REMOTE_DOCROOT_PATH)/$(SYNC_PATH)/ $(HTML_DIR)/$(SYNC_PATH)/ + +.PHONY: deploy +deploy: RSYNC_OPT += $(if $(call check-deploy),,-n) +deploy: guard-sync + $(RSYNC) $(RSYNC_OPT) $(HTML_DIR)/$(SYNC_PATH)/ $(SSH_REMOTE_HOST):$(REMOTE_DOCROOT_PATH)/$(SYNC_PATH)/ + @[[ -z "$(call check-deploy)" ]] \ + && echo 'info: You need to create a file `$(deploy-once-file)` to deploy for once or `$(deploy-always-file)` for skipping this confirmation every time.' + rm -f $(deploy-once-file) + +%.replaced.sql: %.sql + perl -pe " \ + s|$(SITE_URL_PATTERN)|$(LOCAL_URL)|g; \ + s|$(REMOTE_DOCROOT_PATH)|$(LOCAL_DOCROOT)|g; \ + " $< > $@ + +%.replaced.sql.imported: %.replaced.sql | wait-db-up + cat "$^" | $(DOCKER_COMPOSE) exec -T -- db sh -c 'mysql --user $$MYSQL_USER -p$$MYSQL_PASSWORD $$MYSQL_DATABASE' + touch $@ + +replaced-sql-files = $(addsuffix .replaced.sql,$(basename $(filter-out %.replaced.sql,$(wildcard $(SQL_DIR)/*.sql)))) +imported-sql-files = $(addsuffix .imported,$(replaced-sql-files)) + +.PHONY: import-sql +import-sql: $(imported-sql-files) + +.PHONY: wait-db-up +wait-db-up: up + $(DOCKER_COMPOSE) exec -T -- db sh -c ' \ + while [ ! -e /var/run/mysqld/mysqld.sock ] ; do sleep 1 ; done' + +.PHONY: init-conf +init-conf: WP_CONF ?= $(shell $(FIND) $(HTML_DIR)/ -name $(WP_CONFIG_FILENAME) | head -n 1) +init-conf: .db.env + perl -i.orig -pe " \ + s/define\\(\\s*'DB_HOST',\\s*'[^']*'\\s*\\)/define('DB_HOST', 'db')/; \ + s/define\\(\\s*'DB_NAME',\\s*'[^']*'\\s*\\)/define('DB_NAME', '$(MYSQL_DATABASE)')/; \ + s/define\\(\\s*'DB_USER',\\s*'[^']*'\\s*\\)/define('DB_USER', '$(MYSQL_USER)')/; \ + s/define\\(\\s*'DB_PASSWORD',\\s*'[^']*'\\s*\\)/define('DB_PASSWORD', '$(MYSQL_PASSWORD)')/; \ + " $(WP_CONF) + +.PHONY: dump-remote-db +dump-remote-db: WP_CONF = $(shell $(SSH) $(SSH_REMOTE_HOST) -- find $(REMOTE_DOCROOT_PATH) -type f -name $(WP_CONFIG_FILENAME) | head -n 1) +dump-remote-db: get-val = $(shell $(SSH) $(SSH_REMOTE_HOST) -- 'perl -nle "/\\(\\s*'"'"'$1'"'"'\\s*,\\s*'"'"'(.+)'"'"'\\s*\\)/ and print \$$1" $(WP_CONF)') +dump-remote-db: DB_PASSWORD = $(call get-val,DB_PASSWORD) +dump-remote-db: DB_HOST = $(call get-val,DB_HOST) +dump-remote-db: DB_USER = $(call get-val,DB_USER) +dump-remote-db: DB_NAME = $(call get-val,DB_NAME) +dump-remote-db: SQL_FILE = $(SQL_DIR)/$(shell date "+%Y-%m-%d").sql +dump-remote-db: + @$(SSH) $(SSH_REMOTE_HOST) -- mysqldump $(MYSQLDUMP_OPT) -u $(DB_USER) -h $(DB_HOST) -p$(DB_PASSWORD) $(DB_NAME) \ + | $(PV) > $(SQL_FILE) + +.PHONY: purge-db +purge-db: + $(DOCKER_COMPOSE) down -v + rm $(SQL_DIR)/*.imported + +.PHONY: wp-cli +wp-cli: + $(DOCKER_COMPOSE) run --rm -- cli bash diff --git a/build/mailhog/Dockerfile b/build/mailhog/Dockerfile new file mode 100644 index 0000000..71d623b --- /dev/null +++ b/build/mailhog/Dockerfile @@ -0,0 +1,29 @@ +# +# MailHog Dockerfile +# + +FROM docker.io/library/golang:1.15-alpine as builder + +# Install MailHog: +RUN apk --no-cache add --virtual build-dependencies \ + git \ + && mkdir -p /root/gocode \ + && export GOPATH=/root/gocode \ + && go get github.com/mailhog/MailHog + +FROM docker.io/library/alpine:3 +# Add mailhog user/group with uid/gid 1000. +# This is a workaround for boot2docker issue #581, see +# https://github.com/boot2docker/boot2docker/issues/581 +RUN adduser -D -u 1000 mailhog + +COPY --from=builder /root/gocode/bin/MailHog /usr/local/bin/ + +USER mailhog + +WORKDIR /home/mailhog + +ENTRYPOINT ["MailHog"] + +# Expose the SMTP and HTTP ports: +EXPOSE 1025 8025 diff --git a/build/web/Dockerfile b/build/web/Dockerfile new file mode 100644 index 0000000..d4dc1c2 --- /dev/null +++ b/build/web/Dockerfile @@ -0,0 +1,7 @@ +ARG WP_IMAGE_TAG=latest +FROM docker.io/library/wordpress:${WP_IMAGE_TAG} + +# Install mhsendmail +RUN curl -sS https://github.com/mailhog/mhsendmail/releases/download/v0.2.0/mhsendmail_linux_amd64 -L -o /usr/local/bin/mhsendmail \ + && chmod +x /usr/local/bin/mhsendmail \ + && echo 'sendmail_path = "/usr/local/bin/mhsendmail --smtp-addr=127.0.0.1:1025"' > /usr/local/etc/php/conf.d/sendmail.ini diff --git a/db.env.sample b/db.env.sample new file mode 100644 index 0000000..5e11535 --- /dev/null +++ b/db.env.sample @@ -0,0 +1,4 @@ +# Copy as `.db.env` +MYSQL_DATABASE=database +MYSQL_USER=user +MYSQL_PASSWORD=password diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..efa1a2a --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,42 @@ +version: '3.3' + +services: + web: + build: + context: ./build/web/ + args: + WP_IMAGE_TAG: $WP_IMAGE_TAG + restart: always + ports: + - 8000:80 + volumes: + - ./html:/var/www/html + db: + image: docker.io/library/mariadb:${MARIADB_VER:-latest} + restart: always + environment: + MYSQL_RANDOM_ROOT_PASSWORD: 'yes' + env_file: + - .db.env + command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --sql_mode='' + volumes: + - mariadb:/var/lib/mysql + mail: + build: ./build/mailhog/ + ports: + - 8025:8025 + + adminer: + image: docker.io/library/adminer + restart: always + ports: + - 8080:8080 + cli: + image: wordpress:${WP_CLI_IMAGE_TAG} + profiles: + - cli + volumes: + - ./html:/var/www/html + +volumes: + mariadb: diff --git a/dotenv.makefile.sample b/dotenv.makefile.sample new file mode 100644 index 0000000..44928d8 --- /dev/null +++ b/dotenv.makefile.sample @@ -0,0 +1,25 @@ +# Copy this file and edit for your environment and save as `.env.makefile` + +PHP_VER := 8.1 +export MARIADB_VER := 10.3 + +export WP_IMAGE_TAG := php$(PHP_VER)-apache +export WP_CLI_IMAGE_TAG := cli-php$(PHP_VER) + +# WP_INSTALL_DIR := wp +# WP_CONF := $(HTML_DIR)/$(WP_INSTALL_DIR)/wp-config.php + +# DOCKER = PODMAN + +SSH_REMOTE_HOST := example.com + +SITE_URL_PATTERN := https?://(www.)?example.com +LOCAL_URL := http://localhost:8000 + +REMOTE_DOCROOT_PATH := /home/example.com/html +LOCAL_DOCROOT := /var/www/html/ + +# CLONE_EXCLUDE= + +# To use misc +# include misc/disable-really-simple-ssl.makefile diff --git a/gitignore.sample b/gitignore.sample new file mode 100644 index 0000000..2c6a39a --- /dev/null +++ b/gitignore.sample @@ -0,0 +1,19 @@ +*.log +wp-*.php +wp-*.php.orig +wp-*/* +!wp-content/themes/ +/index.php +xmlrpc.php + +.htaccess +.htaccess* +/.gitkeep +.vscode/ +license.txt +readme.html +sitemap.xml +sitemap.xml.gz +XX* +php.cgi +php.ini diff --git a/html/.gitkeep b/html/.gitkeep new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/html/.gitkeep diff --git a/misc/disable-really-simple-ssl.makefile b/misc/disable-really-simple-ssl.makefile new file mode 100644 index 0000000..b8789c2 --- /dev/null +++ b/misc/disable-really-simple-ssl.makefile @@ -0,0 +1,9 @@ +WP_PATH = $(patsubst %/,%,$(HTML_DIR)/$(WP_INSTALL_DIR)) +URL_BASE = $(patsubst %/,%,$(LOCAL_URL)/$(WP_INSTALL_DIR)) + +.PHONY: disable-ssl +disable-ssl: deactive-file = $(shell find $(WP_PATH)/wp-content/plugins -name force-deactivate.txt) +disable-ssl: + $(if $(wildcard $(deactive-file)),, $(error force-deactivate.txt: not found)) + cp $(deactive-file) $(basename $(deactive-file)).php + @echo "Success, don't forget to access \`$(URL_BASE)/wp-content/plugins/really-simple-ssl/force-deactivate.php\` to disable SSL." diff --git a/misc/vaultpress.makefile b/misc/vaultpress.makefile new file mode 100644 index 0000000..6fe6989 --- /dev/null +++ b/misc/vaultpress.makefile @@ -0,0 +1,16 @@ + +WP_PATH = $(patsubst %/,%,$(HTML_DIR)/$(WP_INSTALL_DIR)) + +wp-includes = $(WP_PATH)/wp-includes + +$(wp-includes): + $(DOCKER) run --rm -- docker.io/library/wordpress:$(WP_IMAGE_TAG) tar -cf - --exclude wp-content . \ + | tar -C $(WP_PATH) -xvf - + +.PHONY: extract +extract: | $(wp-includes) + $(if $(wildcard $(file)),,$(error usage: make extract file=<Tar file from VaultPress>)) + $(TAR) -C $(SQL_DIR)/ -xvzf $(file) --strip-components 1 sql/ + $(TAR) -C $(WP_PATH)/ -xvzf $(file) --exclude sql/ --exclude wp-config.php + [[ -e "$(WP_PATH)/wp-config.php" ]] || \ + $(TAR) -C $(WP_PATH)/ -xvzf $(file) wp-config.php diff --git a/sql/.gitkeep b/sql/.gitkeep new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/sql/.gitkeep |