Difference between revisions of "CiviCRM"

From Freephile Wiki
Jump to navigation Jump to search
(extract upgrade)
(add debugging section)
(6 intermediate revisions by the same user not shown)
Line 55: Line 55:
  
 
== Upgrading ==
 
== Upgrading ==
[[{{PAGENAMEE}}/upgrade]]
+
There is a long guide on [http://wiki.civicrm.org/confluence/display/CRMDOC/Upgrading+CiviCRM+for+Drupal+7 how to upgrade CiviCRM for drupal]  
  
== Debugging and the CV command-line ==
+
You should be familiar with all the steps described in the manual, and understand how the particular steps impact/affect your installation.  The short version below is known to work with our setup, and with 'routine' upgrades.
  
If you have your CiviCRM sending errors to the Drupal Watchdog Log (CiviCRM Administer > System Settings > [https://equality-tech.com/civicrm/admin/setting/debug?reset=1 Debugging and Error Handling]), you can simply navigate to it in the Drupal Admin (Reports > [https://equality-tech.com/admin/reports/dblog Recent log messages])
+
Here is the short version:
 +
# backup your database(s) <code>sudo ~/bin/backup.db.sh drupal</code> <code>sudo ~/bin/backup.db.sh civicrm</code> <ref>[[Mysqldump]]</ref>
 +
# download the code <code> wget https://download.civicrm.org/civicrm-4.6.5-drupal.tar.gz</code>
 +
# put site in maintenance mode<code>drush vset maintenance_mode 1</code> (Make sure you are also logged in as Admin)
 +
# move old code, and unpack new code <code>mv civicrm /tmp/ && tar xvzf civicrm-4.6.5-drupal.tar.gz</code>
 +
# run the upgrade script <code>/civicrm/upgrade?reset=1</code>
 +
# put site in operation mode<code>drush vset maintenance_mode 0</code>
 +
# toast
  
 +
== Debugging ==
 
There are many tools you can use to debug your CiviCRM instance.
 
There are many tools you can use to debug your CiviCRM instance.
One of these is the <code>cv</code> tool [https://github.com/civicrm/cv available on Github].
+
One of these is the <code>cv</code> tool available on Github.  Also, don't forget to use [[Drush]] if you're on [[Drupal]]; the CiviCRM API; and the ConfigAndLog directory log.
<pre>
 
cv version v0.1.27
 
 
 
Usage:
 
  command [options] [arguments]
 
 
 
Options:
 
  -h, --help            Display this help message
 
  -q, --quiet          Do not output any message
 
  -V, --version        Display this application version
 
      --ansi            Force ANSI output
 
      --no-ansi        Disable ANSI output
 
  -n, --no-interaction  Do not ask any interactive question
 
  -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
 
 
 
Available commands:
 
  api                    Call an API
 
  cli                    Load interactive command line
 
  dis                    Disable an extension
 
  dl                      Download and enable an extension
 
  en                      Enable an extension
 
  ev                      Evaluate a snippet of PHP code
 
  flush                  Flush system caches
 
  help                    Displays help for a command
 
  list                    Lists commands
 
  path                    Look up the path to a file or directory
 
  scr                    Execute a PHP script
 
  url                    Compose a URL to a CiviCRM page
 
ang
 
  ang:html:list          List Angular HTML files
 
  ang:html:show          Show an Angular HTML file
 
  ang:module:list        List Angular modules
 
api
 
  api:batch              Call an API (batch mode)
 
debug
 
  debug:container        Dump the container configuration
 
  debug:event-dispatcher  Dump the list of event listeners
 
ext
 
  ext:disable            Disable an extension
 
  ext:download            Download and enable an extension
 
  ext:enable              Enable an extension
 
  ext:list                List extensions
 
  ext:uninstall          Uninstall an extension and purge its data
 
  ext:upgrade-db          Apply DB upgrades for any extensions
 
php
 
  php:boot                Generate PHP bootstrap code
 
  php:eval                Evaluate a snippet of PHP code
 
  php:script              Execute a PHP script
 
vars
 
  vars:fill              Generate a configuration file for any missing site data
 
  vars:show              Show the configuration of the local CiviCRM installation
 
</pre>
 
 
 
Also, don't forget to use [[Drush]] if you're on [[Drupal]]; the CiviCRM API; and the ConfigAndLog directory log. The ConfigAndLog directory is in a path like <code>./sites/default/files/civicrm/ConfigAndLog</code>
 
  
 
== Profiles ==
 
== Profiles ==
Line 130: Line 84:
  
 
<blockquote>
 
<blockquote>
Custom tokens (based on custom data) can be added for organizations as well. These tokens will not be displayed in the list of available tokens, but can be added manually. The format is {contact.custom_12} where 12 is the ID of the custom data field. To find the custom data field ID, go Administer > Customize Data & Screens > Custom Fields and click �edit� on the field you want to use. Look at the URL. The last part of the URL will be an equal sign and a number (=12). The number (12 in this example) is the id of that custom field.
+
Custom tokens (based on custom data) can be added for organizations as well. These tokens will not be displayed in the list of available tokens, but can be added manually. The format is {contact.custom_12} where 12 is the ID of the custom data field. To find the custom data field ID, go Administer > Customize Data & Screens > Custom Fields and click on the field you want to use. Look at the URL. The last part of the URL will be an equal sign and a number (=12). The number (12 in this example) is the id of that custom field.
 
</blockquote>
 
</blockquote>
  
Line 314: Line 268:
 
== Extensions ==
 
== Extensions ==
 
* See [https://civicrm.org/extensions/drupal listing of CiviCRM extensions for Drupal]
 
* See [https://civicrm.org/extensions/drupal listing of CiviCRM extensions for Drupal]
* [https://docs.civicrm.org/sysadmin/en/latest/customize/extensions/#installing-a-new-extension  Installing extensions]
+
* [http://wiki.civicrm.org/confluence/display/CRMDOC/Extensions Extensions documentation in the wiki]
There are multiple ways to use the <code>cv</code> command to download and install extensions:
+
* [http://wiki.civicrm.org/confluence/display/CRMDOC/Create+a+Custom-Search+Extension Create a Custom Search extension]
;Download a published extension from the directory (long name).
 
:<code>cv dl org.example.foobar</code>
 
;Download a published extension from the directory (short name).
 
:<code>cv dl foobar</code>
 
;Download an unpublished extension (long name and zip URL)
 
:<code>cv dl org.example.foobar@http://example.org/files/foobar-1.2.zip</code>
 
;Download a pre-release (alpha/beta) from the directory.
 
:<code>cv dl --dev foobar</code>
 
 
 
 
 
  
 
== Developing Extensions ==
 
== Developing Extensions ==

Revision as of 10:28, 14 July 2017