From 1ce0bf927fcd56a8df9d338c6e9e55aee2795e30 Mon Sep 17 00:00:00 2001 From: Thuan Bui <9248622+10h30@users.noreply.github.com> Date: Sun, 27 Apr 2025 21:13:15 +0900 Subject: [PATCH] Update README.md --- README.md | 62 +++++++++++++++++++++++++++++++++++------------ src/lib/docker.sh | 2 +- 2 files changed, 48 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 80c98f5..afbe3d7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # **KazeWP** + **KazeWP** is an open-source tool designed to simplify the deployment and management of multiple WordPress sites behind a lightweight reverse proxy. It uses Docker and Bash scripts to automate configuration, allowing you to quickly set up and scale your WordPress instances with minimal effort. ![KazeWP](images/kazewp.png) @@ -7,21 +8,24 @@ ## **Table of Contents** -- [Features](#features) -- [Getting Started](#getting-started) - - [Prerequisites](#prerequisites) - - [Installation](#installation) -- [Usage](#usage) -- [How It Works](#how-it-works) - - [Caddy (Reverse Proxy)](#caddy-reverse-proxy) - - [WordPress (Site Containers)](#wordpress-site-containers) - - [Dedicated Database (MariaDB)](#dedicated-database-mariadb) - - [Bash Script Automation](#bash-script-automation) -- [Default Plugins and Theme](#default-plugins-and-theme) - - [Pre-installed Plugins](#pre-installed-plugins) - - [Default Theme](#default-theme) -- [License](#license) -- [Acknowledgements](#acknowledgements) +- [**KazeWP**](#kazewp) + - [**Table of Contents**](#table-of-contents) + - [**Features**](#features) + - [**Getting Started**](#getting-started) + - [**Prerequisites**](#prerequisites) + - [**Installation**](#installation) + - [**Usage**](#usage) + - [**How It Works**](#how-it-works) + - [**Caddy (Reverse Proxy)**](#caddy-reverse-proxy) + - [**WordPress (Site Containers)**](#wordpress-site-containers) + - [**Dedicated Database (MariaDB)**](#dedicated-database-mariadb) + - [**Bash Script Automation**](#bash-script-automation) + - [**Default Plugins and Theme**](#default-plugins-and-theme) + - [Pre-installed Plugins](#pre-installed-plugins) + - [Default Theme](#default-theme) + - [**phpMyAdmin**](#phpmyadmin) + - [**License**](#license) + - [**Acknowledgements**](#acknowledgements) --- @@ -115,6 +119,33 @@ Each WordPress installation comes pre-configured with carefully selected plugins These default installations ensure that your WordPress sites are ready for production use with essential SEO, performance, and email functionality out of the box. +--- + +## **phpMyAdmin** + +To use phpMyAdmin with your WordPress sites, follow these steps: + +1. **Choose to Include phpMyAdmin During Site Creation**: + When you are running the installation script to create a new WordPress site, you'll be prompted to include phpMyAdmin. Make sure to opt for PhpMyAdmin during this setup. + +2. **Manually Run phpMyAdmin**: + After the site is set up, you can manually start PhpMyAdmin using Docker Compose. Navigate to your WordPress project directory and execute the following command: + ```bash + docker compose up phpmyadmin -d + ``` +3. **Access phpMyAdmin via IP Address**: + Once phpMyAdmin is running, you can access it by opening a web browser and navigating to `http://:8080`. Replace `` with your server's actual IP address. + +4. **Stop phpMyAdmin**: + To prevent unauthorized access to phpMyAdmin after use, make sure to stop the container. Navigate to your WordPress project directory and execute the following command: + ```bash + docker compose stop phpmyadmin + ``` + + +By following these steps, you can manage your site's database conveniently using PhpMyAdmin. + + --- ## **License** @@ -129,6 +160,7 @@ This project is licensed under the MIT License - see the LICENSE file for detail - [WordPress](https://wordpress.org/) - [Docker](https://www.docker.com/) - [MariaDB](https://mariadb.org/) +- [phpMyAdmin](https://www.phpmyadmin.net/) --- diff --git a/src/lib/docker.sh b/src/lib/docker.sh index a86d84f..7473c89 100644 --- a/src/lib/docker.sh +++ b/src/lib/docker.sh @@ -77,7 +77,7 @@ create_docker_compose() { # Define phpMyAdmin service block PHPMYADMIN_BLOCK=$( cat <<-EOL - phpmyadmin_${DOMAIN}: + phpmyadmin: container_name: phpmyadmin_${DOMAIN} depends_on: - db_${DOMAIN}