Download the PHP package aeliot/osticket-storage-gcs without Composer

On this page you can find all versions of the php package aeliot/osticket-storage-gcs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package osticket-storage-gcs

osTicket: Google Cloud Storage (attachments)

This plugin registers a file storage backend for osTicket so new ticket attachments (and other files stored through the same mechanism) are saved as objects in a Google Cloud Storage bucket instead of the database.

Plugin ID: osticket:storage-gcs
Backend code: G (shown in the system “Store Attachments” dropdown as Google Cloud Storage (bucket/prefix)).

Requirements

Installation

From PHAR (GitHub release)

Use this when you deploy from a release asset instead of a git checkout.

  1. Download osticket-storage-gcs.phar from the GitHub Releases page for the version you want (the file is attached to each release after CI builds it).
  2. Copy the file to your osTicket include/plugins/ directory, keeping the name osticket-storage-gcs.phar (same basename as the source folder so install paths stay predictable).
  3. Do not run Composer in include/plugins/ for this layout—the PHAR already contains vendor and plugin.php at the archive root.
  4. In Admin Panel → Manage → Plugins, add the plugin if it is not registered yet, then enable it and open configuration.

If you previously used the unpacked directory under include/plugins/osticket-storage-gcs/, disable or remove that installation before switching to the PHAR (only one layout should exist for this plugin id), then add the PHAR-based plugin again from the plugins list if needed.

From source (directory + Composer)

  1. Copy the plugin folder to include/plugins/osticket-storage-gcs/ (or install from your deployment process).

  2. From the plugin directory, install PHP dependencies:

    In Docker-based setups (example):

  3. In Admin Panel → Manage → Plugins, add/install the plugin if it is not already listed, then enable it and open its configuration.

Plugin configuration

Open the plugin instance settings and fill in:

Setting Description
GCS bucket name Name of the target bucket (e.g. my-project-osticket-attachments).
Object key prefix Optional prefix for object names (no leading slash), e.g. osticket/prod. Helps separate environments in one bucket.
Service account credentials Either paste the full service account JSON key contents, or enter an absolute filesystem path to a JSON key file that PHP can read (recommended in production: mount a secret and use the path). The JSON must include private_key and client_email.
Default signed URL lifetime (seconds) Optional. If empty, signed download URLs follow the same “expire at midnight UTC” style behaviour as the official S3 storage plugin when osTicket does not pass a shorter TTL. If set, that many seconds are used as the default lifetime in those cases.

Saving the form runs a connectivity check (bucket->info()). If it fails, fix the bucket name, IAM, or credentials before continuing.

Google Cloud IAM (summary)

Grant the service account at least:

For V4 signed URLs (redirect downloads), the account typically also needs permission to sign blobs (e.g. Service Account Token Creator on itself, or use a signing method supported by your environment as described in Google Cloud signed URLs).

Selecting the default storage backend

Enabling the plugin alone does not move attachments to GCS. You must set the system default storage to this backend.

  1. Go to Admin Panel → Settings → System (or your equivalent System settings page).
  2. Under Attachments Storage and Settings, set Store Attachments to the entry labelled Google Cloud Storage (...) (bucket/prefix as configured).

  1. Save settings.

After this, new uploads use backend G. Existing attachments stay on their previous backend until you migrate them (if you use osTicket’s file migration tools).

Verify that objects land in GCS

If bk stays D (database) despite the plugin being enabled, the G backend is usually not registered (missing vendor/autoload.php) or the default storage dropdown was not switched to Google Cloud Storage.

Troubleshooting

License

See the LICENSE file in this repository.

All versions of osticket-storage-gcs with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
google/cloud-storage Version ^1.42
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package aeliot/osticket-storage-gcs contains the following files

Loading the files please wait ...