https://github.com/zauberware/capistrano-payloadcms
https://github.com/zauberware/capistrano-payloadcms
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zauberware/capistrano-payloadcms
- Owner: zauberware
- License: other
- Created: 2025-06-22T18:32:59.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-07T18:07:02.000Z (11 months ago)
- Last Synced: 2025-08-29T06:42:11.359Z (9 months ago)
- Language: Ruby
- Size: 14.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Capistrano::PayloadCMS
Payload CMS integration for Capistrano with systemd support.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'capistrano-payloadcms'
```
And then execute:
```bash
bundle install
```
## Usage
Add the following to your `Capfile`:
```ruby
require 'capistrano/pnpm'
require 'capistrano/payloadcms'
install_plugin Capistrano::PayloadcmsPlugin
install_plugin Capistrano::PayloadcmsSystemd
```
Add the following to your `config/deploy.rb`:
```ruby
# Payload CMS configuration
set :payloadcms_roles, :app
set :payloadcms_env, fetch(:stage)
```
## Available Tasks
- `cap payloadcms:start` - Start Payload CMS application
- `cap payloadcms:stop` - Stop Payload CMS application
- `cap payloadcms:restart` - Restart Payload CMS application
- `cap payloadcms:status` - Check Payload CMS application status
- `cap payloadcms:install` - Install systemd service
- `cap payloadcms:uninstall` - Uninstall systemd service
- `cap payloadcms:build` - Build Payload CMS application
- `cap payloadcms:check` - Check Payload CMS application (lint)
## Configuration
The gem automatically integrates with your deployment process:
- Stops the service before deployment
- Starts the service after successful deployment
- Restarts the service if deployment fails
## Requirements
- Node.js
- pnpm
- systemd (for service management)
## License
The gem is available as open source under the terms of the [LGPL-3.0 License](https://opensource.org/licenses/LGPL-3.0).