Skip to content

Commit 4919a2f

Browse files
authored
Update README.md
1 parent 1c8043a commit 4919a2f

File tree

1 file changed

+36
-19
lines changed

1 file changed

+36
-19
lines changed

README.md

Lines changed: 36 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,53 @@
11
# 🐳 NPP Dockerized [![Docker Build](https://github.com/psaux-it/wordpress-nginx-cache-docker/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/psaux-it/wordpress-nginx-cache-docker/actions/workflows/docker-publish.yml)
22

3-
Welcome to the Docker project optimized for the **[(NPP) WordPress Plugin](https://wordpress.org/plugins/fastcgi-cache-purge-and-preload-nginx/)**! 🎉 This full-stack Dockerized environment is designed for **NPP** usage, including **WordPress**, **PHP-FPM**, **Nginx**, **MySQL**, **FastCGI cache**, **WP-CLI**, and necessary **PHP extensions**. It's tailored for easy deployment and efficient use of the **NPP plugin**, providing a comprehensive solution for **Nginx Cache** management on wordpress.
3+
Welcome to the Docker project optimized for the **[(NPP) WordPress Plugin](https://wordpress.org/plugins/fastcgi-cache-purge-and-preload-nginx/)**! 🎉 This full-stack Dockerized environment is designed for **NPP**, including **WordPress** with **FPM**, **Nginx**, **MySQL**, **FastCGI**, **WP-CLI**, **phpMyAdmin**, and necessary **PHP extensions**. It's tailored for easy deployment and efficient use of the **NPP plugin**
44

55
Explore the **[NPP Main GitHub Repository](https://github.com/psaux-it/nginx-fastcgi-cache-purge-and-preload)** to access the heart of the plugin development.
66

7-
## 🔧 Features
7+
## Features
88

9-
-**WordPress** (6.7.1) with **PHP-FPM** (8.2)
9+
-**WordPress** (6.7.2) with **PHP-FPM** (8.2)
1010
-**MySQL** (8) for database management
11-
-**FastCGI** cache ready with **Nginx** (1.27.3)
12-
-**WP-CLI** ready for plugin and theme installations (safe without --allow-root)
11+
-**FastCGI** cache ready with **Nginx** (1.27.4)
12+
-**WP-CLI** ready for plugin and theme installations (check **.env**)
13+
-**phpMyAdmin** (5.2.2) ready
1314
- ✅ Includes all dependencies required for the **NPP plugin**
1415
- ✅ Isolated and secure **PHP process owner** for enhanced security and performance
1516
- ✅ Built with **bindfs** (1.17.7) + **fuse3** (1.16.2) for FUSE-based mounting of **Nginx Cache Path**
16-
-Supports a wide range of **PHP extensions**
17-
- ✅ Easily switch between the **stable** release and the **bleeding-edge dev** version of the **NPP**
17+
-Installed a wide range of **PHP extensions**
18+
- ✅ Easily switch between the **stable** release and the **bleeding-edge** version of the **NPP**
1819
- ✅ All containers powered by **Debian 12** for a stable, consistent environment
19-
- ✅ Compatible with Windows WSL and Linux Hosts
20+
- ✅ Compatible with both Windows **WSL** and Linux Hosts
2021

2122
## 🔑 Environment Variables
2223

23-
Please check the **.env** file for the environment variables used by the project.
24+
**This repository was primarily created for testing and developing the NPP plugin on local.** However, with minor adjustments, It can also be used as a **production** environment.
2425

25-
Some variables can be directly modified by the user to customize the setup easily, while others are hard depend to the project's core configuration. Modifying these core variables for a production environment may require adjustments in other parts of the project to ensure proper integration and workflow. Feel free to customize it to meet your full-stack WordPress **production** needs!
26+
Please check the **.env** file for the environment variables used in the project. Some variables can be directly modified by the user for easy customization, while others are derived from the **original Dockerfiles of core services**. Changing these **core variables** for a production environment may require adjustments in other parts of the project to maintain seamless integration and workflow. Feel free to customize it to suit your full-stack WordPress **production** needs!
2627

27-
#### Use the Bleeding-Edge Version of NPP or Contribute to Development (Default)
28+
### Use the Bleeding-Edge Version of NPP (Default)
2829

29-
If you want to use the **latest bleeding-edge version** of the NPP plugin or set up a **development/test environment**, simply set the following environment variable:
30+
If you want to use the latest **bleeding-edge version** of the NPP plugin simply set the following environment variable:
3031

3132
```bash
32-
NPP_DEV_ENABLED=1
33+
NPP_EDGE=1
3334
```
3435

3536
🔄 This will sync the plugin with the latest development branch commit from GitHub, ensuring you always have access to the newest features and improvements.
3637

37-
## ⚙️️ Setup Instructions
38+
### ⚠️ In Production
39+
40+
To enable **Nginx Cache Preload** in a **localhost** development environment, a small host configuration adjustment is **always** required. In **production**, this may or may not be required depending on your Docker architecture. If you encounter a **Cache Preload** issue in production, try enabling the below setting in **.env**, otherwise, you can disable it entirely.
41+
42+
```bash
43+
NPP_HACK_HOST=1
44+
```
45+
46+
For a full explanation and to adjust your environment, please read the complete story here:
47+
48+
https://github.com/psaux-it/wordpress-nginx-cache-docker/blob/1c8043a0bc6e2014b55ae6f7259eba134e3f3698/wordpress/wp-post.sh#L129
49+
50+
## ⚙️️ Instant Deployment
3851

3952
### 1. Clone the repository
4053

@@ -47,18 +60,18 @@ cd wordpress-nginx-cache-docker
4760

4861
### 2. Run the Services
4962

50-
Run the following command to build and start the container in detached mode:
63+
Run the following command to build and start the container:
5164

5265
- **Using pre-built images:**
5366

5467
```bash
55-
docker compose up -d
68+
docker compose up
5669
```
5770

5871
- **Building locally:**
5972

6073
```bash
61-
docker compose up -d --build
74+
docker compose up --build
6275
```
6376

6477
### 🚀 **Post-Container Startup Access**
@@ -70,8 +83,12 @@ docker compose up -d --build
7083
- **Username**: `npp`
7184
- **Password**: `npp`
7285

73-
### 🔧 **Nginx Cache Path Configuration**
74-
- Users can use the FUSE mount path **`/var/cache/nginx-npp`** as the Nginx cache path in the NPP plugin settings page.
86+
- You can also access **phpMyAdmin** at:
87+
- https://localhost/phpmyadmin
88+
89+
- Default FUSE mount path:
90+
- **`/var/cache/nginx-npp`**
91+
- Use the FUSE mount path as the Nginx cache path in the NPP plugin settings page.
7592

7693
---
7794
#### ⚠️ Important Notices

0 commit comments

Comments
 (0)