README.md in capistrano-ops-0.2.9 vs README.md in capistrano-ops-0.2.10
- old
+ new
@@ -3,40 +3,48 @@
The capistrano-ops gem is a valuable library, tailor-made for Rails DevOps professionals, offering an array of beneficial scripts to streamline and enhance operations with Capistrano. The focus is on seamless integration with Capistrano version 3 and above.
## Main Features:
🗃️ **Database and Storage Backups:**
- - Create, pull, and manage backups of your Postgres database and server storage.
- - Delegation of old backup removal for both Postgres database and server storage.
+- Create, pull, and manage backups of your Postgres database and server storage.
+- Delegation of old backup removal for both Postgres database and server storage.
+
🛠️ **Configuration Management:**
- - Compare application.yml files between local and server environments using figaro_yml:compare.
- - Fetch server environment variables set via Figaro with figaro_yml:get.
+- Compare application.yml files between local and server environments using figaro_yml:compare.
+- Fetch server environment variables set via Figaro with figaro_yml:get.
+
📜 **Logging and Task Management:**
- - Real-time viewing of Rails server logs.
- - Showcase the server app's crontab generated with the 'whenever' gem.
- - Ability to invoke server-specific rake tasks.
+- Real-time viewing of Rails server logs.
+- Showcase the server app's crontab generated with the 'whenever' gem.
+- Ability to invoke server-specific rake tasks.
+
🔔 **Notification Integrations:**
- - Set up notifications through Slack or generic Webhooks.
- - Customize notification levels (info/error).
+- Set up notifications through Slack or generic Webhooks.
+- Customize notification levels (info/error).
+
⚙️ **Backup Settings Customization:**
- - Define the number of backups retained, both locally and externally.
- - Toggle backup tasks and external backups.
- - S3 integration for backup storage, including customization of bucket, region, and endpoint details.
+- Define the number of backups retained, both locally and externally.
+- Toggle backup tasks and external backups.
+- S3 integration for backup storage, including customization of bucket, region, and endpoint details.
+
📅 **Schedule Tasks:**
- - Couple with the 'whenever' gem to schedule daily backup creation and old backup removal.
+- Couple with the 'whenever' gem to schedule daily backup creation and old backup removal.
+
🔗 **Slack & Webhook Integrations:**
- - Integrate seamlessly with Slack or use webhooks for notifications, alerting you on essential operations or any potential issues.
+- Integrate seamlessly with Slack or use webhooks for notifications, alerting you on essential operations or any potential issues.
+
☁️ **Backup Providers:**
- - S3 and other S3-compatible services are supported to ensure your data remains secure and accessible.
+- S3 and other S3-compatible services are supported to ensure your data remains secure and accessible.
+
## Requirements
```ruby
'capistrano', '~> 3.0'
'whenever'
@@ -114,9 +122,10 @@
| NUMBER_OF_BACKUPS | number of backups to keep (default: 7) | `number` |
| NUMBER_OF_LOCAL_BACKUPS | number of backups to keep locally (default: nil) | `number` |
| NUMBER_OF_EXTERNAL_BACKUPS | number of backups to keep externally (default: nil) | `number` |
| BACKUPS_ENABLED | enable/disable backup task (default: Rails.env == 'production') | `boolean` |
| EXTERNAL_BACKUP_ENABLED | enable/disable external backup (default: false) (only if 'BACKUPS_ENABLED', needs additional setup) | `boolean` |
+| KEEP_LOCAL_STORAGE_BACKUPS | keep local storage backups (default: Rails.env == 'production') | `boolean` |
| DEFAULT_URL | notification message title (default: "#{database} Backup") | `string` |
| NOTIFICATION_TYPE | for notification (default: nil) | `string` (`webhook`/`slack`) |
| NOTIFICATION_LEVEL | for notification (default: nil) | `string` (`info`/`error`) |
| SLACK_SECRET | for slack integration | `string` (e.g. `xoxb-1234567890-1234567890-1234567890-1234567890`) |
| SLACK_CHANNEL | for slack integration | `string` (e.g. `C234567890`) |