| .github | ||
| app | ||
| bin | ||
| bootstrap | ||
| bruno | ||
| config | ||
| database | ||
| docker | ||
| meta/bin | ||
| public | ||
| resources | ||
| routes | ||
| storage | ||
| tests | ||
| .dockerignore | ||
| .editorconfig | ||
| .env.example | ||
| .gitattributes | ||
| .gitignore | ||
| .pre-commit-config.example.yaml | ||
| artisan | ||
| CHANGELOG.md | ||
| composer.json | ||
| composer.lock | ||
| docker-compose.override.yml.dist | ||
| docker-compose.yml | ||
| jsconfig.json | ||
| LICENSE | ||
| mago.toml | ||
| Makefile | ||
| package.json | ||
| phpstan.dist.neon | ||
| phpunit.xml | ||
| postcss.config.js | ||
| psalm.xml | ||
| README.md | ||
| tailwind.config.js | ||
| vite.config.js | ||
| yarn.lock | ||
AspireCloud
This project is designed to function as a CDN/API endpoint system for distributing WordPress assets (themes, plugins, core) to users of the AspirePress Updater.
Setup
Quick Start
make init
Next configure WordPress to use your local version of AspireCloud, and you're good to go!
Note: you'll have to add api.aspiredev.org to your /etc/hosts file to point to 127.0.0.1.
Importing Plugins and Themes from AspireSync
- Create a user with the RepoAdmin role (or use the built-in
admin@aspirecloud.ioadmin user) - Create an API key for that user through the Jetstream UI.
- Check out and build AspireSync
- Set
ASPIRECLOUD_ADMIN_API_URLandASPIRECLOUD_ADMIN_API_KEYin your local environment- note: putting them only in
.env.localwill not work!
- note: putting them only in
- Run the following:
bin/console sync:meta:fetch:plugins -vvv
bin/console sync:meta:fetch:themes -vvv
bin/console sync:meta:dump:plugins | meta/bin/push-to-aspirecloud
bin/console sync:meta:dump:themes | meta/bin/push-to-aspirecloud
XDebug Instructions for PHPStorm
- Go to Settings > PHP > Debug and check "Break at first line of PHP scripts."
- Go to Settings > PHP > Servers and create a server with your desired hostname.
- Edit the
docker-compose.override.yml.distfile so that the server name matches the one you entered in Step #2. - Copy
docker-compose.override.yml.disttodocker-compose.override.ymlto include it in Docker. Then runmake down upto restart Docker. - Go to Run > Edit Configurations. Add a PHP Remote Debug configuration. Select your server and enter the PHPSTORM IDE key.
- Click the debug icon to start listening for debug connections.
- Refresh the page. It should stop at the first line of execution. If not, repeat the steps and use
xdebug_info()to verify XDebug’s activity. - Once debugging works, remove the "Break at first line..." setting from Step #1 to allow the program to progress until it hits breakpoints.
Using https://api.aspiredev.org instead of localhost
The local dev instance can be reached this way by enabling a Traefik proxy server:
make traefik-up
Next, add an entry to your /etc/hosts file (C:\Windows\System32\drivers\etc\hosts on Windows).
127.0.0.1 api.aspiredev.org
::1 api.aspiredev.org
Note about SSL/TLS (https:// urls)
Because the proxy generates self-signed certs, you will get security warnings the first time you access the container after it is rebuilt. Any other access will also need to disable certificate validation.
Also note that plain old http://api.aspiredev.org always works.
Notes
AspireCloud operates as an API and a pseudo pull-through cache against WordPress.org. This means that if AspireCloud provides the requested endpoint, it attempts to deliver the resource; otherwise, it passes the request through to WordPress.org and returns their response to the end user.
The long-term goal is to gradually implement WordPress.org APIs to reduce reliance on their website and endpoints.
Important: Please do not use this project to flood or harass the WordPress.org website. We don't want to get banned from using their resources!
License
This project is licensed under the MIT License. You may exercise all rights granted by the MIT license, including using this project for commercial purposes.
