https://github.com/opr/homepage

https://github.com/opr/homepage

Last synced: 23 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/opr/homepage
• Owner: opr
• License: mit
• Created: 2015-10-18T20:19:42.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-11-01T22:29:30.000Z (about 9 years ago)
• Last Synced: 2024-10-04T15:57:25.523Z (about 1 month ago)
• Language: CSS
• Size: 3.6 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# bedrock-capistrano

These are the Capistrano configs for deploying [Bedrock](https://github.com/roots/bedrock) projects.

[Capistrano](http://www.capistranorb.com/) is a remote server automation and deployment tool. It will let you deploy or rollback your application in one command:

Screencast (:moneybag:): [Deploying WordPress with Capistrano](https://roots.io/screencasts/deploying-wordpress-with-capistrano/)

**Status**: This project is stable, feature complete, and production ready. This means that we won't be adding new features. Only fixing existing bugs and ensuring that base functionality works.

## Requirements

* Ruby >= 1.9

Required Gems:

* `capistrano` (> 3.1.0)

* `capistrano-composer`

These can be installed manually with `gem install ` but it's highly suggested you use [Bundler](http://bundler.io/) to manage them. Bundler is basically the Ruby equivalent to PHP's Composer. Just as Composer manages your PHP packages/dependencies, Bundler manages your Ruby gems/dependencies. Bundler itself is a Gem and can be installed via `gem install bundler` (sudo may be required).

The `Gemfile` in the root of this repo specifies the required Gems (just like `composer.json`). Once you have Bundler installed, run `bundle install` to install the Gems in the `Gemfile`. When using Bundler, you'll need to prefix the `cap` command with `bundle exec` as seen below (this ensures you're not using system Gems which can cause conflicts).

See http://capistranorb.com/documentation/getting-started/authentication-and-authorisation/ for the best way to set up SSH key authentication to your servers for password-less (and secure) deploys.

## Installation/configuration

1. Copy the following files into the root of your Bedrock project:

  * `Capfile`

  * `Gemfile`

  * `Gemfile.lock`

2. Copy the following files/folders into your `config` directory:

  * `config/deploy/*`

  * `config/deploy.rb`

3. Edit your `config/deploy/` stage/environment configs to set the roles/servers and connection options.

4. Before your first deploy, run `bundle exec cap  deploy:check` to create the necessary folders/symlinks.

5. Add your `.env` file to `shared/` in your `deploy_to` path on the remote server for all the stages you use (ex: `/srv/www/example.com/shared/.env`)

6. Run the normal deploy command: `bundle exec cap  deploy`

7. Enjoy one-command deploys!

## Usage

* Deploy: `cap production deploy`

* Rollback: `cap production deploy:rollback`

Composer support is built-in so when you run a deploy, `composer install` is automatically run. Capistrano has a great [deploy flow](http://www.capistranorb.com/documentation/getting-started/flow/) that you can hook into and extend it.

## Contributing

Contributions are welcome from everyone. We have [contributing guidelines](CONTRIBUTING.md) to help you get started.

## Support

Use the [Roots Discourse](https://discourse.roots.io/) forum to ask questions and get support.