Working with Joomla

Lando offers a configurable recipe for spinning up Joomla apps. Let's go over some basic usage.

Getting Started

Before you get started with this recipe we assume that you have:

  1. Installed Lando
  2. Read up on how to get a .lando.yml

If after reading #2 above you are still unclear how to get started then try this

# Go into a local folder with your site or app codebase
# You can get this via git clone or from an archive
cd /path/to/my/codebase

# Initialize a basic .lando.yml file for my recipe with sane defaults
lando init

# Commit the .lando.yml to your git repo (Optional but recommended)
git add -A
git commit -m "MAKE LOCAL DEV GREAT AGAIN"
git push

For more info on how lando init works check out this.

Starting Your Site

Once you've completed the above you should be able to start your Joomla site.

# Start up app
lando start

# Optionally run composer install if needed
lando composer install

If you visit any of the green-listed URLs that show up afterwards you should be welcomed with the Joomla installation screen.

If you are installing Joomla from scratch will also want to scope out your database credentials by running lando info so you can be prepped to enter them during the Joomla installation. You will want to use internal_connection information. Note that you will likely have to open up the Advanced Settings during the Joomla database configuration to change the hostname.

Or you can read below on how to import your database.

Importing Your Database

Once you've started up your Joomla site you will need to pull in your database and files before you can really start to dev all the dev. Pulling your files is as easy as downloading an archive and extracting it to the correct location. Importing a database can be done using our helpful lando db-import command.

# Go into my app
cd /path/to/my/app

# Grab your database dump
curl -fsSL -o database.sql.gz "https://url.to.my.db/database.sql.gz"

# Import the database
# NOTE: db-import can handle uncompressed, gzipped or zipped files
lando db-import database.sql.gz

You can learn more about the db-import command over here

Tooling

Each Lando Joomla recipe will also ship with helpful dev utilities. This means you can use things like joomla, composer and php-cli via Lando and avoid mucking up your actual computer trying to manage php versions and tooling.

lando composer                 Run composer commands
lando db-export [file]         Export a database. Resulting file: {DB_NAME}.TIMESTAMP.gz
lando db-import [file]         Import into database.
lando joomla                   Run joomla commands
lando mysql                    Drop into a MySQL shell
lando php                      Run php commands
# Get joomla cli help
lando joomla help

# Clear the joomla cache
lando joomla cache:clear

# Run composer install
lando composer install

# Drop into a mysql shell
lando mysql

# Check the app's php version
lando php -v

You can also run lando from inside your app directory for a complete list of commands.

Configuration

Recipe

You can also manually configure the .lando.yml file to switch php or joomla versions, toggle between apache and nginx, activate xdebug, choose a database type and version, set a custom webroot locaton and use your own configuration files.

# Joomla recipe
name: joomla

# Start with the default joomla recipe
recipe: joomla

# Configure the joomla recipe
config:

  # https://downloads.joomla.org/us/technical-requirements-us

  # Optionally specify the php version to use.
  #
  # If ommitted this will default to the latest php version supported by joomla.
  # Consult the `php` service to see what versions are available. Note that all
  # such versions may not be supported in joomla so YMMV.
  #
  # See: https://docs.joomla.org/Technical_requirements
  #
  # NOTE: that this needs to be wrapped in quotes so that it is a string
  #
  php: '7.0'

  # Optionally specify whether you want to serve joomla via nginx or apache
  #
  # If ommitted this will default to the latest apache
  #
  # See: https://docs.joomla.org/Technical_requirements
  #
  via: nginx

  # Optionally specify the location of the webroot relative to your approot.
  #
  # If ommitted this will be your approot itself.
  #
  webroot: web

  # Optionally specify the database type, this can be one of:
  #
  #   - `mysql`
  #   - `mariadb`
  #   - `postgres`
  #
  # If ommitted this will default to the latest mysql. You can additionally provide
  # a version with `type:version` but you will need to consult the documentation
  # for the correct DB service to see what versions are available
  #
  database: mariadb:10.1

  # Optionally activate xdebug
  #
  # If you are having trouble getting xdebug to work please see:
  # https://docs.devwithlando.io/services/php.html#using-xdebug
  xdebug: true

  # Optionally mix in your own config files
  #
  # If ommitted this will use "sane defaults" for your recipe type
  # conf:

    # For more information on setting these files check out the documentation
    # and examples
    #
    # Docs: https://docs.devwithlando.io/services/php.html
    # Examples: https://github.com/lando/lando/tree/master/examples
    #
    # server: config/joomla.conf
    # php: config/php.ini

    # For more information on setting these files check out the documentation
    # and examples for the relevant services:
    #
    # MySQL: https://docs.devwithlando.io/services/mysql.html
    # MariaDB: https://docs.devwithlando.io/services/mariadb.html
    # PostGres: https://docs.devwithlando.io/services/postgres.html
    #
    # Examples: https://github.com/lando/lando/tree/master/examples
    #
    # database: config/mysql

You will need to rebuild your app with lando rebuild to apply the changes to this file. You can check out the full code for this example over here.

Environment Variables

Lando will add some helpful environment variables into your appserver so you can get database credential information. These are in addition to the default variables that we inject into every container. These are accessible via php's getenv() function.

DB_HOST=database
DB_USER=joomla
DB_PASSWORD=joomla
DB_NAME=joomla
DB_PORT=3306

These are in addition to the default variables that we inject into every container. Note that these can vary based on the choices you make in your recipe config.

Advanced Service Usage

You can get more in-depth information about the services this recipe provides by running lando info.

Read More

Workflow Docs

Advanced Usage

results matching ""

    No results matching ""