Skip to content

Latest commit

 

History

History
217 lines (145 loc) · 7.61 KB

readme.md

File metadata and controls

217 lines (145 loc) · 7.61 KB
Raw

NodeJS WordPress Nginx

Lamma - WordPress Local Development CLI

Lamma is a lightweight homebrew-based development environment tool designed for effortless WordPress site management on your local machine.

Prerequisites

Before harnessing the power of Lamma, ensure that the following software is installed on your system:

  • NodeJS: Lamma relies on Node.js, so you'll need version 16 or newer. Download it from nodejs.org.

  • Homebrew: To get Homebrew, open your terminal and execute this command:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  • MySQL or MariaDB: Ensure that MySQL or MariaDB is installed and running as a service with Homebrew. If not, please follow the steps here.

Usage

Lamma boasts an array of commands that you can invoke using the lamma command, followed by your desired action. Here's a summary of the available commands:

lamma sites [--all]

List all configured sites. Use the --all option for a more detailed listing.

lamma info <name>

Retrieve information about a specific site.

lamma add --name <name> [--title <title>] [--theme <theme>] [--plugins <plugins>]

Create a new site with customizable options:

  • --name: The name of the new site (required).
  • --title: The title of the new site (optional).
  • --theme: The ID of the theme to use (optional).
  • --plugins: A comma-separated list of plugin IDs to use (optional).

lamma remove <name>

Remove a site by providing its name as an argument.

lamma logs <name>

Display logs for a specific site.

lamma wp <name>

WP CLI alias for a specific site.

lamma add-plugins <name>

Add a symlink to a plugin within the site's plugins directory.

lamma unmanage-plugins <name>

Remove a symlink to a plugin by copying the plugin's files to the site's plugins directory.

lamma switch-theme <name>

Change the theme of a specific site.

lamma php-change <name> <phpVersion>

Change the PHP version of a specific site.

lamma server <action>

Manage the Nginx server with the following actions:

  • install: Install Nginx.
  • status: Check the status of the Nginx server.
  • reload: Reload the Nginx configuration.
  • php: Check the PHP status.

lamma hosts-doctor

Fix the hosts file for all configured sites.

lamma php-doctor

Assign distinct port numbers to PHP-FPM versions and set the process owner to the current user. Be cautious, as it may interrupt existing PHP connections.

Additional Options

  • --help (-h): Display help information for the script and its commands.
  • --version (-v): Display the script's version information.

Managing Projects

Lamma can search for themes and plugins in the ~/.woa_projects.json file, a JSON file listing all your projects. This file should be in your home directory (~/). Here's a sample:

[
  {
    "name": "Project 1",
    "value": "project1",
    "args": [
      "--exclude",
      ".git",
      "--exclude",
      ".cache",
      "--exclude",
      "node_modules/",
      "--exclude",
      "tests/"
    ],
    "localDir": "/path/to/project1",
    "remoteDir": "/path/to/remote/project1"
  },
  {
    "name": "Project 2",
    "value": "project2",
    "args": [
      "--exclude",
      ".git",
      "--exclude",
      ".cache",
      "--exclude",
      "node_modules/",
      "--exclude",
      "tests/"
    ],
    "localDir": "/path/to/project2",
    "remoteDir": "/path/to/remote/project2"
  }
]

Each project is defined with the following properties:

  • name: The project's name.
  • value: A unique identifier.
  • args: An array of rsync arguments for project syncing.
  • localDir: The local directory where the project resides.
  • remoteDir: The directory inside the site's document root.

By maintaining your projects in .woa_projects.json, you can effortlessly manage themes and plugins across all your projects with Lamma.

Installation

To install Lamma, follow these steps:

  1. Clone the repository to your local machine.
  2. Navigate to the cloned directory.
  3. Run npm install to install dependencies.
  4. Copy the env.sample file to .env and fill it in with your specific details.
  5. Run npm run setup to configure the tool.
  6. (Optional) Create ~/.woa_projects.json with your project list (refer to the example in the Managing Projects section). Ensure that you avoid trailing commas in your JSON objects or properties.
  7. (Optional) Run the source command as described to update the shell or open a new terminal window.

Install and Start MySQL with Homebrew

  • If you haven't already installed MySQL, you can do so using Homebrew. Open your terminal and run the following command:
brew install mysql
  • After the installation is complete, start the MySQL service with the following command:
brew services start mysql

This will ensure that MySQL runs as a background service, and it will start automatically whenever you boot your computer.

Set a Default Root Password

  • To access MySQL, open your terminal and run the following command:
mysql -u root

You may be prompted to enter your password. If you haven't set a password yet, just press Enter (leave it blank) for now.

  • Once you are in the MySQL shell, use the following SQL command to set the root user's password to 'root' (you can replace 'root' with your desired password):
ALTER USER 'root'@'localhost' IDENTIFIED BY 'root';
  • Exit the MySQL shell by typing:
exit;

Now, you have MySQL installed and running as a service with Homebrew, and the root user's password has been set to 'root'. Be sure to secure your database by using a strong and secure password in production environments.

Disclaimer

Please take note of the following important considerations when using Lamma:

  1. Nginx Configuration Backup: When you install Lamma, it will replace the default Nginx configuration. To ensure that your original configuration is not lost, Lamma creates a backup file at ${brew --prefix}/etc/nginx/nginx.lamma.backup.conf. In the event of any issues, you can restore your previous Nginx configuration from this backup.

  2. PHP FPM Port Configurations: Running the lamma php-doctor command may modify existing PHP FPM port configurations. Please exercise caution when using this command, especially if you have specific PHP configuration requirements. Also, I have only tested this using FPM port numbers instead of socket files.

Troubleshooting

  • httpd Service Conflict: Lamma is designed to work with Nginx and may conflict with Apache or other httpd services running at port 80. Ensure that you have no conflicting services running on the same port to avoid any issues.

  • Troubleshooting PHP FPM Services: If you encounter difficulties with starting any [email protected] FPM service, you can try reinstalling the dependencies by running the following command (e.g., for PHP 8.1):

brew reinstall $(brew deps shivammathur/php/[email protected]) shivammathur/php/[email protected]
brew services start [email protected]

This command can help resolve dependencies and potential issues with PHP FPM services.

License

This project is licensed under the MIT License. For more details, see the LICENSE file.