pressbooks / local-dev-environment

This repository uses Lando/Docker to provision a local instance of Pressbooks for testing and development by open source contributors.

Setup Development Environment

This repository uses Lando/Docker to provision a local instance of Pressbooks for testing and development by open source contributors. It uses the public pressbooks/bedrock repo and has been tested with GNU/Linux and MacOS.

NOTE: This repo is intended to help developers quickly provision a Pressbooks instance locally. It should not be deployed to production environments, as it lacks several features that are useful for hosted environments (like a persistent object cache backend).

Requirements

• Git
• Lando

Setup steps

1. Install Git & Lando

2. Clone this repo:

   git clone [email protected]:pressbooks/local-dev-environment.git

   If this is your first time attempting to clone a GitHub repository, you may need to configure your computer to access GitHub via SSH key by following these instructions: https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent and https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account or following this helpful video tutorial: https://www.youtube.com/watch?v=8X4u9sca3Io.

3. Add 127.0.0.1 pressbooks.test to your /etc/hosts file on its own line.

4. Copy these two environment files:

   cp .env.example .env && 
   cp config_services/.env.example config_services/.env

5. Fill in the requested ARCHITECTURE variable in config_services/.env with the chip architecture used by your computer (i.e. amd64 or arm64).

6. Replace the following values in the .env file with values generated at https://roots.io/salts.html

   AUTH_KEY='generateme'
   SECURE_AUTH_KEY='generateme'
   LOGGED_IN_KEY='generateme'
   NONCE_KEY='generateme'
   AUTH_SALT='generateme'
   SECURE_AUTH_SALT='generateme'
   LOGGED_IN_SALT='generateme'
   NONCE_SALT='generateme'

7. Start your Docker Services

   lando start

   During the build process, you may be asked for an installation folder for Prince:

   Install directory
   This is the directory in which Prince 20220930 will be installed.
   Press Enter to accept the default directory or enter an alternative.
   [/usr]: 

   Press Enter to accept the default directory.

8. Import the prepared sample database included in this repo:

   lando db-import pb_local_db.sql

9. Install Pressbooks testing utilities

   lando install-tests

10. [Optional] Tell your host machine to trust the default Lando Certificate Authority by following these instructions: https://docs.lando.dev/core/v3/security.html#trusting-the-ca

Web access

Once you have completed these steps, you should be able to use Pressbooks locally by visiting http://pressbooks.test or https://pressbooks.test.

Running tests

You can run tests inside your Lando instance with the following commands: lando test (this is a shortcut which runs the core Pressbooks unit tests inside your container)

lando testbyfilter <FILTER_NAME> Run only a specific test, for example: lando testbyfilter test_pressbooks_cg_design_callback. Accepts wildcards.

lando testbygroup <GROUPNAME> Run only a specific group of tests, for example: lando testbygroup covergenerator.

XDebug configuration in PHPSTORM

You can configure XDebug locally by adding a new PHP Remote Debug configuration and setting the following values:

• Name: appserver
• Host: pressbooks.test
• Port: 443
• Use path mappings: /app/web -> /app/web

Add DB Connection in PHPSTORM

You can set up access to your database in PHPStorm by creating a new MariaDB connection and setting the following values:

1. Run lando info and note the host and port values used by your database service.
2. In PHPStorm, open the Database menu (on the right side of the IDE), click the + button and add a new MariaDB connection.
3. Enter the following connection data:
   • The host and port values obtained by running lando info earlier
   • user: wordpress
   • password: wordpress
   • database: wordpress

Notes

• The sample database includes a single empty public book and a single super admin user with a username / password of admin / admin.
• The .env.example file provides some additional environment variables which can be used with your local Pressbooks installation but are commented out by default. If you wish to install the optional PB MathJax service, you can do so following the instructions here: https://github.com/pressbooks/pb-mathjax?tab=readme-ov-file#installation. Once you've launched the service, you can uncomment the relevant line in your local .env file. Similar sample .env variables are provided for optional DocRaptor, Sentry, Redis, and Algolia integrations.
• lando info provides a list of all the services and their ports.
• You can install or update dependencies in the container or any repo by navigating to the desired location and running lando composer install or lando composer update.
• For SSH access to the appserver you can run: lando ssh or lando ssh -u root (if you wish to access the appserver as the root user)
• You can shut down the container by running lando stop.
• Logs can be read with lando logs.