GoAdmio

vendor

Reinstall GoAdmio's PHP libraries (Composer packages) from scratch, or add specific packages without touching the rest

On this page: Overview · Quick start · Syntax · Arguments · Output · Examples · Troubleshooting · Details · See also


Overview

GoAdmio's PHP code relies on third-party libraries managed by Composer, stored in /usr/local/goadmio/includes. /go/vendor installs them. It has two modes:

It runs Composer as the go user and locks the folder to read-only when it finishes.

[!WARNING] With no arguments, the folder is emptied first. If the downloads then fail (no internet, a Composer error, running out of memory), the libraries are gone and the features that use them stop working until a run succeeds. Back the folder up first (see Examples).


Quick start

# Reinstall everything (empties the folder first)
/go/vendor

# Add one package, leaving the rest alone
/go/vendor monolog/monolog

Syntax

# Reinstall the full set
/go/vendor

# Add one or more packages
/go/vendor <package> [<package> ...]

Arguments

Argument Required Notes
package No A Composer package name such as vendor/name. Optionally add a version, as in monolog/monolog:^3.0.

Arguments are passed straight to composer require, so anything that command accepts works. Without a version, the newest compatible version is installed.


Output

Line Meaning
Installing VENDORS... The command started.
Composer messages Downloads, installed versions, and any errors.

The command prints no summary of its own and ends with exit code 0 even if a package failed. Read Composer's messages for errors.


Examples

# Back up the folder before a full reinstall
cp -a /usr/local/goadmio/includes /root/includes.bak
# Full reinstall
/go/vendor
# Add a package
/go/vendor monolog/monolog
# Add a package at a specific version
/go/vendor monolog/monolog:^3.0
# Add several packages at once
/go/vendor symfony/yaml symfony/console
# List the installed packages and their versions
sudo -u go composer show -d /usr/local/goadmio/includes

Troubleshooting

Symptom Likely cause Fix
Features that need the libraries stopped working after a run A full reinstall emptied the folder and the downloads failed. Run /go/vendor again once the cause is fixed, or copy back your backup.
composer: command not found Composer is not installed. Install it with composer.
sudo: unknown user: go The go system user does not exist. Check the GoAdmio installation.
"Your requirements could not be resolved" The package needs a newer PHP version or a missing PHP extension. Check defaultphp and extension, then run /go/vendor <package> for that package alone.
Download errors or timeouts The server cannot reach Packagist or GitHub. Check the network, DNS (resolver), and firewall.
Killed or "memory exhausted" Composer ran out of memory on a small server. Add swap with swap, then run again.
Versions changed after a reinstall Packages are not pinned, so every full run installs the newest versions. Reinstall with a version (package:^x.y), or copy back your backup.
Cannot edit files in the folder The folder is set to read-only (555) after every run. Run /go/vendor (it unlocks the folder at the start), or change the permissions by hand.
One package failed but the others installed A failure does not stop the run. Run /go/vendor <package> for the failed one.
It takes a long time Several large packages are downloaded one after another. Wait. A full run can take several minutes.

Details

What it does

flowchart TD
    A["/go/vendor [packages]"] --> B["Append the command to /var/log/go/vendor.log"]
    B --> C["Create includes and .composer folders, set 777"]
    C --> D{"Packages given?"}
    D -- "No" --> E["Delete everything in includes"]
    E --> F["composer require each of the 11 libraries, one by one"]
    D -- "Yes" --> G["composer require the given packages"]
    F --> H["Set includes to 555"]
    G --> H

Steps in order

  1. Appends a timestamped line with the arguments to /var/log/go/vendor.log.
  2. Prints Installing VENDORS....
  3. Creates /usr/local/goadmio/includes and /usr/local/goadmio/.composer if needed, and sets both to 777.
  4. Changes into /usr/local/goadmio/includes.
  5. With no arguments: deletes everything in the folder, then runs composer require for each library below, as the go user.
  6. With arguments: runs composer require for those packages, as the go user.
  7. Sets /usr/local/goadmio/includes to 555 (read and execute only).

Libraries installed by a full run

Package What it is
laravel/framework The Laravel PHP framework
firebase/php-jwt JSON Web Token encoding and decoding
guzzlehttp/guzzle HTTP client
google/apiclient Google APIs client
phpmailer/phpmailer Sending email
sonata-project/google-authenticator Google Authenticator two-factor codes
giggsey/libphonenumber-for-php Phone number parsing and validation
bluerhinos/phpmqtt MQTT client
twilio/sdk Twilio API client
googleads/google-ads-php Google Ads API client
aws/aws-sdk-php AWS SDK

Several of these are large, so a full run needs disk space and a stable connection.

Permissions

Path During the run After the run
/usr/local/goadmio/includes 777 555
/usr/local/goadmio/.composer 777 777 (never tightened)

[!NOTE] 777 lets any user on the server write to the folder. During the run this applies to includes, and the .composer folder (Composer's usual cache and settings location) is left that way permanently. On a server where other people have shell access, tighten it by hand, for example chown -R go /usr/local/goadmio/.composer && chmod -R 750 /usr/local/goadmio/.composer.

Notes


See also

Command Description
composer Install Composer (PHP dependency manager)
defaultphp Change the default PHP version in the CLI
extension List, install, or remove PHP extensions across every version
installphp Install a different PHP version on GoAdmio
package Install all base packages required by GoAdmio
swap Create a swap file sized to RAM and set vm.swappiness
update Update GoAdmio to the latest version via the command line