Git Integration with WordPress on Staq<\/h2>\n
Staq makes it easy to integrate Bitbucket or Github into any environment\u2014production, development, or staging. You can even select which branch to sync!<\/p>\n
How WordPress Git Integration Works on Staq<\/h3>\n\n- Create or migrate your site (dev, staging, or production).<\/li>\n
- If already live, simply integrate Git into your existing environment.<\/li>\n
- For staging, create a staging site from the Staq Panel (optionally exclude plugins\/themes if they are managed via Git).<\/li>\n<\/ol>\n
Once ready, go to the site’s Staq Panel \u2192 Integrations<\/strong> \u2192 Git<\/strong>:<\/p>\n![\"Git](\"https:\/\/www.wpstaq.com\/wp-content\/uploads\/2025\/04\/git-integration.png\")
<\/p>\n
Step 1 – Enter Git Details<\/h3>\n\n- Select Git service: GitHub or Bitbucket<\/li>\n
- Enter repository URL and branch<\/li>\n<\/ul>\n
![\"\"](\"https:\/\/www.wpstaq.com\/wp-content\/uploads\/2025\/04\/git-repo-integration-step-1.png\")
<\/p>\n
Step 2 – Add SSH Keys<\/h3>\n\n- Generate and copy the SSH Key.<\/li>\n
- Paste it into your repository’s access keys and label it.<\/li>\n<\/ul>\n
![\"SSH](\"https:\/\/www.wpstaq.com\/wp-content\/uploads\/2025\/04\/generate-ssh-access-keys.png\")
<\/p>\n
and paste the SSH key here. Also create the label name also:<\/p>\n
![\"\"](\"https:\/\/www.wpstaq.com\/wp-content\/uploads\/2025\/04\/add-ssh-key.png\")
<\/p>\n
Step 3 – Add Webhook<\/h3>\n\n- Copy the webhook URL and add it to the repository’s webhooks.<\/li>\n<\/ul>\n
![\"Webhook\"](\"https:\/\/www.wpstaq.com\/wp-content\/uploads\/2025\/04\/git-webhook.png\")
<\/p>\n
Then, add your webhook URL and follow the prompts:<\/p>\n
![\"\"](\"https:\/\/www.wpstaq.com\/wp-content\/uploads\/2025\/04\/click-webhook.png\")
<\/p>\n
Step 4 – Final Setting<\/h3>\n\n- Optionally Disable Auto-Updater <\/strong>which disables the Staq Plugin\/Theme auto-updater for plugin\/theme updates<\/li>\n
- Disable Media Uploads Sync<\/strong> feature which disables the media uploads folder syncing from Git to your WordPress environment<\/li>\n
- Purge Cache After Sync<\/strong> which clears the site’s front-end cache (includes Staq Cache and WP Rocket) and Redis Object Cache (if enabled)<\/li>\n<\/ul>\n
![\"\"](\"https:\/\/www.wpstaq.com\/wp-content\/uploads\/2025\/04\/git-integration-existing.png\")
<\/p>\n
Once the setup has been confirmed inside the Staq interface after clicking Connect Git<\/strong>, every time you push to the selected branch, the webhook triggers Staq to securely identify the branch and perform a pull<\/b> operation automatically.<\/p>\nGeneral Actions<\/h2>\n\n- Disconnect Git<\/strong>: Disconnects your site from the Git repository.<\/li>\n
- Event Logs:\u00a0<\/strong>Allows you to see the history of events Staq listened and performed on your site.<\/li>\n
- Force Pull:\u00a0<\/strong>Manually triggers a pull and sync request as if your code was pushed.<\/li>\n
- Save Options:\u00a0<\/strong>Edits the existing options and updates the site’s behaviour.<\/li>\n<\/ul>\n
What Happens Under the Hood?<\/b><\/h2>\n
When Git integration is enabled on Staq, the following process takes place to ensure stability, security, and consistency:<\/p>\n
\n- \/wordpress<\/b> \u2013 This is your live WordPress directory that serves the site.<\/li>\n
- \/wordpress-git<\/b> \u2013 A new isolated directory is created where your Git repository is cloned and updated.<\/li>\n
- After each Git pull, Staq automatically runs a sync script<\/b> that copies updated files from \/wordpress-git<\/b> into the live \/wordpress<\/b> directory.<\/li>\n<\/ul>\n
This separation prevents conflicts between the Git repository and live files, ensuring you have full control over what gets deployed while keeping the live site protected during updates.<\/p>\n
Important:<\/b> During the sync process, files from \/wordpress-git<\/b> overwrite matching files in \/wordpress<\/b>. Any files not in Git are preserved unless explicitly managed. Core WordPress files and critical server files are automatically protected\u2014see below.<\/p>\nWhat Files Are Ignored Automatically?<\/b><\/h2>\n
For security and consistency, Staq always excludes WordPress core files and hosting-specific files<\/b> from syncing \u2014 even if you mistakenly push them to your Git repository.<\/p>\n
Automatically excluded files and directories:<\/p>\n
\n- # WordPress core files\n
\n- wp-includes\/<\/li>\n
- wp-admin\/<\/li>\n
- index.php<\/li>\n
- xmlrpc.php<\/li>\n
- license.txt<\/li>\n
- readme.html<\/li>\n
- wp-*.php<\/li>\n
- wp-content\/cache\/<\/li>\n
- wp-content\/*backup*\/<\/li>\n
- wp-content\/upgrade\/<\/li>\n
- wp-content\/temp\/<\/li>\n<\/ul>\n<\/li>\n
- # Hosting-specific files\n
\n- login.php<\/li>\n
- .stq_*<\/li>\n<\/ul>\n<\/li>\n
- # Git repository itself\n
\n- .git\/<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
This ensures that WordPress core files are always managed by Staq, and no accidental overwrites occur.<\/p>\n
Note:<\/b> Staq enforces an even stricter policy \u2014 a Core Files Integrity Scanner<\/b> runs regularly to block any modification to core WordPress files, even if changes are made outside Git (via SFTP or plugins).<\/p>\nOptional: Use .deployignore<\/code> to Exclude Additional Files<\/b><\/h2>\nBeyond the automatic exclusions, you can control what files should not sync by adding a .deployignore<\/b> file inside your Git repository.<\/p>\n
This follows a simple rsync-compatible pattern<\/b> \u2014 one path per line, with optional comments using #<\/code>.<\/p>\nExample .deployignore<\/code> file:<\/b><\/p>\n# Exclude user uploads\r\nwp-content\/uploads\r\n\r\n# Exclude backup folders\r\nwp-content\/*backups*\r\n\r\n# Exclude build artifacts\r\nwp-content\/plugins\/my-plugin\/node_modules\r\n<\/pre>\nStrongly recommended:<\/b> Using .deployignore<\/code> helps:<\/p>\n
Once ready, go to the site’s Staq Panel \u2192 Integrations<\/strong> \u2192 Git<\/strong>:<\/p>\n and paste the SSH key here. Also create the label name also:<\/p>\n Then, add your webhook URL and follow the prompts:<\/p>\n Once the setup has been confirmed inside the Staq interface after clicking Connect Git<\/strong>, every time you push to the selected branch, the webhook triggers Staq to securely identify the branch and perform a pull<\/b> operation automatically.<\/p>\n When Git integration is enabled on Staq, the following process takes place to ensure stability, security, and consistency:<\/p>\n This separation prevents conflicts between the Git repository and live files, ensuring you have full control over what gets deployed while keeping the live site protected during updates.<\/p>\n Important:<\/b> During the sync process, files from \/wordpress-git<\/b> overwrite matching files in \/wordpress<\/b>. Any files not in Git are preserved unless explicitly managed. Core WordPress files and critical server files are automatically protected\u2014see below.<\/p>\n For security and consistency, Staq always excludes WordPress core files and hosting-specific files<\/b> from syncing \u2014 even if you mistakenly push them to your Git repository.<\/p>\n Automatically excluded files and directories:<\/p>\n This ensures that WordPress core files are always managed by Staq, and no accidental overwrites occur.<\/p>\n Note:<\/b> Staq enforces an even stricter policy \u2014 a Core Files Integrity Scanner<\/b> runs regularly to block any modification to core WordPress files, even if changes are made outside Git (via SFTP or plugins).<\/p>\n Beyond the automatic exclusions, you can control what files should not sync by adding a .deployignore<\/b> file inside your Git repository.<\/p>\n This follows a simple rsync-compatible pattern<\/b> \u2014 one path per line, with optional comments using Example Strongly recommended:<\/b> Using <\/p>\nStep 1 – Enter Git Details<\/h3>\n
\n
<\/p>\nStep 2 – Add SSH Keys<\/h3>\n
\n
<\/p>\n<\/p>\nStep 3 – Add Webhook<\/h3>\n
\n
<\/p>\n<\/p>\nStep 4 – Final Setting<\/h3>\n
\n
<\/p>\nGeneral Actions<\/h2>\n
\n
What Happens Under the Hood?<\/b><\/h2>\n
\n
What Files Are Ignored Automatically?<\/b><\/h2>\n
\n
\n
\n
\n
Optional: Use
.deployignore<\/code> to Exclude Additional Files<\/b><\/h2>\n#<\/code>.<\/p>\n.deployignore<\/code> file:<\/b><\/p>\n# Exclude user uploads\r\nwp-content\/uploads\r\n\r\n# Exclude backup folders\r\nwp-content\/*backups*\r\n\r\n# Exclude build artifacts\r\nwp-content\/plugins\/my-plugin\/node_modules\r\n<\/pre>\n
.deployignore<\/code> helps:<\/p>\n