search

pressbooks / local-dev-environment

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

Issues encountered during fresh install on MacOS #1

Closed SteelWagstaff closed 6 months ago

SteelWagstaff commented 6 months ago

I worked with Michelle to try to install Pressbooks locally using these instructions on her Apple M1 Pro running Sonoma 14.2.1 (23C71). Here are the issues we encountered:

SSH problems

No local SSH key and No SSH key in GitHub.

Resolved by creating SSH key locally: https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent and adding it to GitHub: https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account. See also this helpful video tutorial: https://youtu.be/8X4u9sca3Io?si=rdL3chT5ZPXEGPyO

cp: cannot stat '/user/.ssh/config': No such file or directory error when running lando start

This is because we try to run cp /user/.ssh/config ~/.ssh: https://github.com/pressbooks/local-dev-environment/blob/8eb7536db871b39825b351b17654bdf12c3f15be/.lando.yml#L33-L34

An open source developer who also got this message wrote:

I have SSH keys, of course :slightly_smiling_face:, and the public ones are on github. I don't know in what context cp /user/.ssh/config ~/.ssh should be run, but I couldn't make sense of it (unless one has a global config for all users, but that should not overwrite the local users config). Should this copy the user's local SSH configuration into the lando context, so it can pull from github?

I think the recommended Lando method is described here: https://docs.lando.dev/core/v3/ssh.html#using-a-custom-ssh-config-file

Couldn't successfully run lando composer-login.

When running the command, we saw You should configure your credentials on config_services/.env message (because the composer.sh script doesn't find the expected PACKAGIST_USER env variable): https://github.com/pressbooks/local-dev-environment/blob/8eb7536db871b39825b351b17654bdf12c3f15be/scripts/composer.sh#L2

Repeated prompting for authorization token when running composer lando install.

When Michelle attempted to run composer lando install without successfully running composer-login first, she was repeatedly prompted for a token. We resolved by adding packagist.com config to global composer configuration inside Lando. Went to packagist.com and then ran composer composer config --global --auth http-basic.repo.packagist.com MichelleWeremczuk TOKEN

For first time user, what configuration is needed to successfully run composer lando install? Answer is probably here? https://docs.lando.dev/php/config.html#installing-composer

Missing dependencies error message for Pressbooks Network Catalog after install.

Resolved by running lando ssh && cd web/app/plugins/pressbooks-network-catalog/ && composer install

We should figure out how to ensure that the dependencies for pressbooks-network-catalog are correctly installed upon initial build.

SteelWagstaff commented 6 months ago

These issues should all be fixed by https://github.com/pressbooks/local-dev-environment/commit/701ea82011bf157e13fdb9178a8f3b046b8095b1