{"id":28742335,"url":"https://github.com/programmerqeu/capistrano-typo3-cms","last_synced_at":"2025-06-16T08:41:20.117Z","repository":{"id":8219179,"uuid":"9656382","full_name":"programmerqeu/capistrano-typo3-cms","owner":"programmerqeu","description":"Capistrano deployment with TYPO3 CMS","archived":false,"fork":false,"pushed_at":"2015-04-07T15:17:55.000Z","size":298,"stargazers_count":10,"open_issues_count":1,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-05-29T01:08:11.983Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/programmerqeu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-04-24T19:53:46.000Z","updated_at":"2018-09-27T11:32:04.000Z","dependencies_parsed_at":"2022-08-06T22:15:23.403Z","dependency_job_id":null,"html_url":"https://github.com/programmerqeu/capistrano-typo3-cms","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/programmerqeu/capistrano-typo3-cms","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/programmerqeu%2Fcapistrano-typo3-cms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/programmerqeu%2Fcapistrano-typo3-cms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/programmerqeu%2Fcapistrano-typo3-cms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/programmerqeu%2Fcapistrano-typo3-cms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/programmerqeu","download_url":"https://codeload.github.com/programmerqeu/capistrano-typo3-cms/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/programmerqeu%2Fcapistrano-typo3-cms/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260127238,"owners_count":22962779,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-16T08:41:19.298Z","updated_at":"2025-06-16T08:41:20.106Z","avatar_url":"https://github.com/programmerqeu.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# capistrano-typo3-cms \n\nThis is an extension for the deployment tool Capistrano. This extension facilitates the deploy of TYPO3 CMS projects. This tool ist only testet on Unix based systems.\nA German introduction can be reached [here](http://goo.gl/6B9Cj).\n\n**It includeds follows additional packages:** \n\n1. [capistrano](http://www.capistranorb.com/)\n- [capistrano-ext](https://github.com/neerajkumar/capistrano-ext)\n- [railsless-deploy](https://github.com/leehambley/railsless-deploy/)\n\n[Thank you!](#thanks)\n\n___\n\n[![Build Status](https://travis-ci.org/programmerqeu/capistrano-typo3-cms.png?branch=major/0)](https://travis-ci.org/programmerqeu/capistrano-typo3-cms)\n[![Gem Version](https://badge.fury.io/rb/capistrano-typo3-cms.png)](http://badge.fury.io/rb/capistrano-typo3-cms)\n[![Dependency Status](https://gemnasium.com/programmerqeu/capistrano-typo3-cms.png)](https://gemnasium.com/programmerqeu/capistrano-typo3-cms)\n[![Code Climate](https://codeclimate.com/github/programmerqeu/capistrano-typo3-cms.png)](https://codeclimate.com/github/programmerqeu/capistrano-typo3-cms)\n[![Coverage Status](https://coveralls.io/repos/programmerqeu/capistrano-typo3-cms/badge.png?branch=master)](https://coveralls.io/r/programmerqeu/capistrano-typo3-cms)\n[![Inline docs](http://inch-ci.org/github/programmerqeu/capistrano-typo3-cms.svg?branch=master\u0026style=flat-square)](http://inch-ci.org/github/programmerqeu/capistrano-typo3-cms)\n\n[![Codeship Status for programmerqeu/capistrano-typo3-cms](https://www.codeship.io/projects/58027520-cc72-0130-8afd-129f740051c5/status?branch=master)](https://www.codeship.io/projects/4919)\n\n\n## Installation\n\nInstall it yourself wit rubygems package manager:\n```bash\ngem install capistrano-typo3-cms\n```    \n\n**Need help** to [install ruby](http://docs.rubygems.org/read/chapter/3)? \nOr easer and better with [RVM](https://rvm.io)\n\n## Usage\n\n### Configuration\n\n**Capify** your project\n```bash\n$ cd /path/to/your/project\n$ capify ./\n```\nEdit your **./Capfile** in your project root to include _capistrano-typo3-cms_\n\n```ruby\nload 'deploy' if respond_to?(:namespace)\nrequire 'capistrano'\nrequire 'capistrano-typo3-cms'\nload 'config/deploy' # remove this line to skip loading any of the default \n```\n\nEdit your **./config/deploy.rb** in enable multistage support:\n\n```ruby\nset :stages, %w(production staging)\nset :default_stage, \"staging\"\nrequire 'capistrano/ext/multistage'\nset :application,\t\t\"your-prject-name\"\nset :user,\t\t\t\t\"www-data\"\nset :group,\t\t\t\t\"www-data\"\n``` \n\n#### Enviroments\n- **Development:** Your local maschine. In best case with a simular operation system to staging and production. On this maschine you run you unit tests. Do you have one? ;o)\n- **Staging:** System to run unit and integration test on system. This is a system that is almost equal to the production system in configuration, data and installed software. Also this instance of your TYPO3 CMS can be a place to present your customer new features befor you deploy it on production.\n- **Production:** Some guys call it also live system. Maybe it's also a life system, if your life depends on everything here works well. It's the last step in our basic deployment process. The place where the client can sea your website. Mybe you can run additional Capistrano task after deploy such a minimize and optimize CSS, Images and Javascript to improve the performance.\n\nIt's **possible to extend this process** with addition steps but theese are the default settings that come with this extension.\n\n```ruby\nset :env_development,\t\"development\"\nset :env_staging,\t\t\"staging\"\nset :env_production,\t\"production\"\n``` \n*You will need this, to targeting your deployments.*\n \n#### deploy strategy\n```ruby\nset :deploy_via,\t\t\t:rsync_with_remote_cache\nset :scm, :git\nset :copy_exclude,\t\t\t\".DS_Store\", \".git/*\", \".git\", \".gitignore\", \".gitmodules\"]\n```\n \n#### ssh \u0026 shell settings\n```ruby\nset :use_sudo,\t\t\t\tfalse\nset :ssh_options,\t\t\t{ :keys =\u003e %w(~/.ssh/id_dsa ~/.ssh/id_rsa) }\nset :ssh_options,\t\t\t{ :forward_agent =\u003e true }\nset :ssh_local,\t\t\t\t'ssh'\ndefault_run_options[:shell]\t\t= '/bin/bash'\nset :php_cli,\t\t\t\t\"php\"\n```\n \n#### rsync  (rsync_with_remote_cache)\n```ruby\nset :local_cache,\t\t\t\"cache/rsync\"\nset :rsync_options,\t\t\t\"-avz --delete --chmod=u=rwx,g=rx,o=r --exclude=*.svn* \"\nset :copy_exclude,\t\t\t[\"REVERSION\", \".svn\", \".svn/*\", \".git/*\", \".git\", \".gitignore\", \".gitmodules\"]\nset :rsync_local,\t\t\t\"rsync\"\n```\n \n#### repository\n```ruby\nset :repository,\t\t\t\"git@bitbucket.org:vergissberlin/#{application}.git\"\nset :git_enable_submodules,\t\t1\nset :branch,                            \"#{rails_env}\"\nset :branch,\t\t\t\t\"master\"\n```\n\n#### remote\n```ruby\nset :keep_releases,\t\t\t10\nset(:deploy_to)\t\t\t\t{ \"/var/www/#{application}/#{rails_env}/deploy\" }\nset :deploy_via,\t\t\t:remote_cache\nset :rails_env,\t\t\t\t\"production\"\n```\n\nAdd your enviroments settings file at **./config/deploy/staging.rb** (for example)\n```ruby\nserver 'staging.server.eu', :app, :web, :primary =\u003e true\nset :rails_env, 'staging'\n```\n\n\nIn case of using multistage create config files for every enviroment (deploy/staging.rb):\n- http://capifony.org/cookbook/using-the-multistage-extension.html\n- https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension\n\n### Deploy\n\tcap \u003cenviroment\u003e deploy:setup\n\tcap \u003cenviroment\u003e deploy\n\n\n## Project roadmap\n### Version 0.0.1\n\n- Documentation \"Deploying with Capistrano and TYPO3 CMS\n- Resolving dependencies for PHP projects\n\n### Version 1.0.0\n\nAdditional TYPO3:CMS tasks\n\n\ttypo3:cms:setup\n\ttypo3:cms:cc\n\ttypo3:cms:check\n\ttypo3:cms:data:push\n\ttypo3:cms:data:pull\n\ttypo3:cms:data:backup\n\n### Version 2.0.0\nIncluding new package \"capistrano-mysql\" to manage database data.\n\n\tmysql:push\n\tmysql:pull\n\tmysql:backup\n\tmysql:sync \u003csource_env\u003e \u003ctarget_env\u003e\n\tmysql:migrate\n\t\n### Version 3.0.0\n\n###### Scaffolding\nCLI command support to create a new TYPO3 CMS project from the scratch.\n```bash\n$ typo3 init ./\n```\n###### Add progress bar to follow tasks:\n- **typo3:cms**\n  - :backup\n  - :sync\n- **mysql**\n  - :backup\n  - :pull\n  - :push\n\n\n## Dear PHP Developers\nI did not want that this tool may grow to a meta package, so I have refrained from creating unnecessary dependencies.\nBut I want to recommend you some very useful extensions of Capistrano.\n\n### Useful Capistrano Extensions\nHere is a list of ''Capistrano extension'' you should install:\n\n1. [Capistrano Confirm](https://github.com/jinzhu/capistrano-confirm)\n\n#### Installation and activation\n\n    sudo gem install capistrano-confirm\n\nAfter installation, you can add the script to your Capfile:\n\n    require 'capistrano-confirm'\n\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n### Install locally\n```bash\n$ cd /path/to/capistrano-typo3-cms/\n$ rake build\n$ sudo gem install --local pkg/capistrano-typo3-cms-1.0.0.gem\n```\n\n\u003ca name=\"thanks\"\u003e\u003c/a\u003e\n## Thanks to\n1. A special thanks to **Jamis Buck** and **Lee Hambley**, the developers of Capistrano. \n- Thank you to developers of capistrano-ext and railess-deploy. \n- Further thanks **JetBrains** for a free license for RubyMine. \n\n\u003ca href=\"http://www.jetbrains.com/ruby/features?utm_source=RubyMineUser\u0026utm_medium=Banner\u0026utm_campaign=RubyMine\"\u003e\n\u003cimg src=\"http://www.jetbrains.com/img/logos/RubyMine_logo.gif\" alt=\"Sponsored by RubyMine from JetBrains\" title=\"Sponsored by RubyMine from JetBrains\" width=\"200\" align=\"right\"\u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprogrammerqeu%2Fcapistrano-typo3-cms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprogrammerqeu%2Fcapistrano-typo3-cms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprogrammerqeu%2Fcapistrano-typo3-cms/lists"}