Download the PHP package ised-isde/remote-manage without Composer

On this page you can find all versions of the php package ised-isde/remote-manage. 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 remote-manage

Remote Management for Websites

PHP PostgreSQL GitHub Issues License

Written by: Duncan Sutter, Samantha Tripp and Michael Milette
Initial release: July 2020 - https://github.com/ised-isde-canada/remote-manage
License: MIT

Note: This is the initial draft of the documentation.

This script is the main entry point for Remote Management. Operations are:

For more information and other options, see the Help file.

It has been tested with Moodle and Drupal sites. The backup function only includes your application and data files and database, not the operating system.

Contributing

For more information about contributing, see CONTRIBUTING.md.

Coding Guidelines

Please follow the PHP Standards Recommendations at https://www.php-fig.org/psr/

Installation

Dependencies

You will also need enough space, up to 120% of the space used by your application, data files and database export, in your /tmp area in order to store the temporary backup files.

Using composer

Installation is done using (composer)[https://getcomposer.org/]:

composer require ised-isde/remote-manage

Configuration

You can backup, list backups and restore a backup of your application using the command line. Before you can do anything, you need to set your environment variables so that your host can communicate with the S3 bucket. Set these variables accordingly:

AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
AWS_S3_BUCKET
AWS_S3_REGION

Also set an environment variable called APP_NAME which will be used as part of the backup filenames.

In order to backup and restore application with a database, you will need to set the following environment variables:

DB_HOST
DB_USERNAME
DB_PASSWORD
DB_NAME
DB_PORT

If these are not set, Remote Manage will skip backing up the database.

In order to backup and restore application files, set the following environment variable:

HOME - set to your application's webroot.
MOODLE_DATA_DIR - set to the moodledata directory (for Moodle only).

If these are not set, Remote Manage will skip backing up all files.

You can specify an alternate location for temporary storage of backup files by setting the RM_TEMP environment variable to an alternate directory path. If not specified, /tmp will be used.

Usage

Backup and restore your application

Note: Backup of application files is only currently supported for Moodle.

To backup your application:

php vendor/ised-isde/remote-manage/manage backup <app-name>

To get a list of previous backups:

php vendor/ised-isde/remote-manage/manage s3list <app-name>

To restore:

php vendor/ised-isde/remote-manage/manage restore <backup-file-in-s3-bucket>

Troubleshooting

Be sure to check out the --verbose option. See the Help file.

Copyright

Copyright 2020-2021 Duncan Sutter, Samantha Tripp and Michael Milette

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

All versions of remote-manage with dependencies

PHP Build Version
Package Version
Requires aws/aws-sdk-php Version ^3.155
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 ised-isde/remote-manage contains the following files

Loading the files please wait ...