{"id":23148196,"url":"https://github.com/fivefifteen/wordup","last_synced_at":"2025-08-17T17:33:37.915Z","repository":{"id":266731958,"uuid":"899185867","full_name":"fivefifteen/wordup","owner":"fivefifteen","description":"A WordPress Deployer Recipe. 🤙","archived":false,"fork":false,"pushed_at":"2025-04-04T18:39:41.000Z","size":77,"stargazers_count":3,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-13T17:56:25.561Z","etag":null,"topics":["deploy","deployer","deployer-php","deployment","download","provision","recipe","remote","rollback","tool","upload","version-control","wordpress","wordpress-deployment","wordpress-development"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fivefifteen.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-05T19:25:01.000Z","updated_at":"2025-03-30T21:23:00.000Z","dependencies_parsed_at":"2024-12-30T21:40:37.041Z","dependency_job_id":null,"html_url":"https://github.com/fivefifteen/wordup","commit_stats":null,"previous_names":["fivefifteen/wordup"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/fivefifteen/wordup","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivefifteen%2Fwordup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivefifteen%2Fwordup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivefifteen%2Fwordup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivefifteen%2Fwordup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fivefifteen","download_url":"https://codeload.github.com/fivefifteen/wordup/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fivefifteen%2Fwordup/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270679227,"owners_count":24626929,"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","status":"online","status_checked_at":"2025-08-16T02:00:11.002Z","response_time":91,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["deploy","deployer","deployer-php","deployment","download","provision","recipe","remote","rollback","tool","upload","version-control","wordpress","wordpress-deployment","wordpress-development"],"created_at":"2024-12-17T17:09:40.001Z","updated_at":"2025-08-17T17:33:37.636Z","avatar_url":"https://github.com/fivefifteen.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n  \u003ca href=\"https://github.com/fivefifteen/wordup\"\u003e\n    \u003cpicture\u003e\n      \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"./assets/wordup-white.png\"\u003e\n      \u003cimg src=\"./assets/wordup.png\" alt=\"WordUp\"\u003e\n    \u003c/picture\u003e\n  \u003c/a\u003e\n\n  # WordUp\n\n  A WordPress [Deployer Recipe](https://deployer.org).\n\n  [![packagist package version](https://img.shields.io/packagist/v/fivefifteen/wordup.svg?style=flat-square)](https://packagist.org/packages/fivefifteen/wordup)\n  [![packagist package downloads](https://img.shields.io/packagist/dt/fivefifteen/wordup.svg?style=flat-square)](https://packagist.org/packages/fivefifteen/wordup)\n  [![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/fivefifteen/wordup?style=flat-square)](https://github.com/fivefifteen/wordup)\n  [![license](https://img.shields.io/github/license/fivefifteen/wordup.svg?style=flat-square)](https://github.com/fivefifteen/wordup/blob/main/license.md)\n\n  \u003ca href=\"https://fivefifteen.com\" target=\"_blank\"\u003e\u003cimg src=\"./assets/fivefifteen.png\" /\u003e\u003cbr /\u003e\u003cb\u003eA Five Fifteen Project\u003c/b\u003e\u003c/a\u003e\n\n\u003c/div\u003e\n\n\n## Table of Contents\n\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Setup](#setup)\n- [Configuration](#configuration)\n    - [Configuration Options](#configuration-options)\n- [Tasks](#tasks)\n    - [Database Tasks](#database-tasks)\n    - [Templates Tasks](#templates-tasks)\n    - [Uploads Tasks](#uploads-tasks)\n    - [WordPress Tasks](#wordpress-tasks)\n- [Usage](#usage)\n    - [Usage Examples](#usage-examples)\n- [License Information](#license-information)\n\n\n## Requirements\n\n- PHP 8.1 or above\n- Composer\n\n\n## Installation\n\n```sh\ncomposer require-dev fivefifteen/wordup\n```\n\n\n## Setup\n\nTo get started, copy [examples/deploy.php](examples/deploy.php) and [examples/deploy.yml](examples/deploy.yml) into the root of your project. You'll then want to update both of those files to meet your needs.\n\n\n## Configuration\n\nConfiguration options can be defined/updated in either `deploy.yml` or by using the [add](https://deployer.org/docs/7.x/api#add)/[set](https://deployer.org/docs/7.x/api#set) functions in `deploy.php`.\n\nWordUp uses [Deployer](https://deployer.org/docs/7.x/basics) and it's [Common Recipe](https://deployer.org/docs/7.x/recipe/common) at it's core so you'll want to familiarize yourself with both of those.\n\n\n### Configuration Options\n\nThese are options that are custom to WordUp. See the source of [recipe/wordup.php](recipe/wordup.php) to view the default values (as well as any built-in Deployer options that WordUp modifies).\n\n - `db/credentials` - A list of database credentials\n     - `host` - The database host\n     - `name` - The database name\n     - `user` - The database username\n     - `pass` - The database password\n     - `prefix` - The database tables prefix\n     - `charset` - The database charset\n     - `collate` - The database collate\n - `db/exports_dir` - The name of the directory to save database exports to\n - `db/exports_path` - The remote path to save database exports to\n - `db/keep_exports` - If falsy, database exports will not be deleted from the remote server after downloading\n - `db/keep_local_exports` - If truthy, database exports will be deleted from the local environment after importing\n - `templates/files` - A list of `.mustache` files to be rendered\n - `templates/temp_dir` - A temporary directory to store template files before uploading them to a remote server\n - `wp/config/constants` - An associative array of constants to be defined in `wp-config.php`\n - `wp/config/extra_php` - PHP code to be included in `wp-config.php`\n - `wp/config/require` - A list of files to be required by `wp-config.php`\n - `wp/content_dir` - The name of WordPress's content directory\n - `wp/content_path` - The remote path to WordPress's content directory\n - `wp/home` - The home URL for your WordPress website\n - `wp/salts/temp_dir` - A temporary directory to store generated salts\n - `wp/siteurl` - The URL to the WordPress directory\n - `wp/uploads_dir` - The name of the WordPress uploads directory\n - `wp/uploads_path` - The remote path to the WordPress uploads directory\n\n\n## Tasks\n\n### Database Tasks\n\n - `db:export` - Exports the local database\n - `db:import` - Imports a database export into the local database\n - `db:export:remote` - Exports and downloads the remote database\n - `db:import:remote` - Uploads a local database export and imports it into the remote database\n - `db:pull` - Pulls remote database to localhost (invokes `db:export:remote` and `db:import`)\n - `db:push` - Pushes local database to remote host (invokes `db:export` and `db:import:remote`)\n\n### Templates Tasks\n\n - `templates:render` - Renders mustache template files\n\n### Uploads Tasks\n\n - `uploads:pull` - Pulls uploads from remote to local\n - `uploads:push` - Pushes uploads from local to remote\n - `uploads:sync` - Syncs uploads between local and remote\n\n### WordPress Tasks\n\n - `wp:config:create` - Generates a wp-config.php file\n - `wp:salts:php` - Generates salts in PHP format and saves them to a file\n - `wp:salts:json` - Generates salts in JSON format and saves them to a file\n - `wp:salts:yml` - Generates salts in YML format and saves them to a file\n\n\n## Usage\n\n```sh\ndep \u003ctask\u003e \u003cstage\u003e\n```\n\n### Usage Examples\n\n```sh\n# Deploy to staging\ndep deploy staging\n\n# Export the database from production, download it, and import it into the local database\ndep db:pull production\n\n# Generate a wp-config.php file for my local environment\ndep wp:config:create localhost\n```\n\n## License Information\n\nMIT. See the [license.md file](license.md) for more info.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffivefifteen%2Fwordup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffivefifteen%2Fwordup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffivefifteen%2Fwordup/lists"}