{"id":20022128,"url":"https://github.com/modxcms/vapor","last_synced_at":"2025-05-05T01:31:10.572Z","repository":{"id":3906835,"uuid":"4995456","full_name":"modxcms/vapor","owner":"modxcms","description":"Create a MODX Cloud compatible snapshot from a MODX site","archived":false,"fork":false,"pushed_at":"2020-01-22T18:28:52.000Z","size":30,"stargazers_count":7,"open_issues_count":8,"forks_count":6,"subscribers_count":9,"default_branch":"develop","last_synced_at":"2025-04-28T12:23:49.709Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/modxcms.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-07-11T21:34:58.000Z","updated_at":"2022-08-31T18:40:37.000Z","dependencies_parsed_at":"2022-09-16T01:54:06.041Z","dependency_job_id":null,"html_url":"https://github.com/modxcms/vapor","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modxcms%2Fvapor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modxcms%2Fvapor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modxcms%2Fvapor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modxcms%2Fvapor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/modxcms","download_url":"https://codeload.github.com/modxcms/vapor/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252423057,"owners_count":21745538,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T08:39:17.185Z","updated_at":"2025-05-05T01:31:05.559Z","avatar_url":"https://github.com/modxcms.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MODX Vapor\n\nThis is MODX Vapor, a PHP script for Extracting a complete snapshot of a MODX site, including it's file and database artifacts for use in importing the site into MODX Cloud.\n\n\n## Environment Requirements\n\n- PHP 5.2+\n- PHP Zip extension\n- All requirements for MODX 2.1+\n\n\n## Installation\n\n- Install the project as an immediate subdirectory of the `MODX_BASE_PATH` for the MODX site you want to extract as a vapor package. This subdirectory is referred to as the VAPOR_DIR for the remainder of this document.\n\n\n## Usage\n\nMODX Vapor can be run from the CLI or from a web browser. It is recommended that it be run from CLI if possible however, to avoid potential issues with web server and/or PHP-related timeouts. This is especially true for larger MODX sites. In either case, the snapshot will be created in your `MODX_CORE_PATH . 'packages/'` directory with the snapshot name indicated in the output from the script.\n\n### Running via CLI\n\nTo create a MODX Cloud-compatible snapshot of your MODX site via CLI, change directory to your `MODX_BASE_PATH` and run `VAPOR_DIR . 'vapor.php'`, e.g.\n\n    php vapor/vapor.php\n\n_NOTE: The `vapor/` subdirectory is the `VAPOR_DIR`_\n\n### Running via Browser\n\nTo create a MODX Cloud-compatible snapshot of your MODX site via your browser, navigate to `MODX_SITE_URL . VAPOR_DIR . 'vapor.php'` in your browser and wait for the process to complete, e.g.\n\n    http://localhost/revo/vapor/vapor.php\n\n### Custom Options\n\nThere are a few options available for customizing the execution of Vapor. You can define these options by creating a `VAPOR_DIR . 'config.php'` file with the following contents:\n\n```php\n\u003c?php\nreturn array(\n    'excludeFiles' =\u003e array(),\n    'excludeExtraTables' =\u003e array(),\n    'excludeExtraTablePrefix' =\u003e array(),\n);\n```\n\n- __excludeFiles__ \u0026mdash; An array of file/directory names (do not include the trailing / on directory names) to exclude from the `MODX_BASE_PATH`. Normally Vapor would package up any non-core files located within your `MODX_BASE_PATH`. Define specific items you want to skip here.\n- __excludeExtraTables__ \u0026mdash; An array of non-core tables to exclude from your database. Normally Vapor will package any non-core tables in the database.\n- __excludeExtraTablePrefix__ \u0026mdash; An array of non-core tables to not prepend with your MODX `table_prefix`. Normally, Vapor will keep track of which non-core tables need to have a table_prefix prepended when Injected into the target MODX site, but if the source MODX site does not define a `table_prefix`, Vapor has to assume all of them will need the target's `table_prefix`. Define specific tables that should not get the target's `table_prefix` upon Injection here if your source database does not use a `table_prefix`. _This is not necessary if the source does define a `table_prefix`._\n\n\n## Troubleshooting\n\n### Review the Vapor log\n\nEach time you run vapor it will log information about it's execution into a file with the same timestamp as the zip file that gets created (i.e. the server time when vapor is run). This file will be in the format `vapor-{timestamp}.log` and located in your logs directory at `{core_path}cache/logs/` (or `{core_path}cache/{MODX_CONFIG_KEY}/logs` if using a custom MODX_CONFIG_KEY value).\n\n\n## Copyright\n\nMODX Vapor is Copyright 2012-2013 by MODX, LLC.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodxcms%2Fvapor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmodxcms%2Fvapor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodxcms%2Fvapor/lists"}