|
1 | | -## Pre-requisites |
| 1 | +# Introduction |
2 | 2 |
|
3 | | -CiviCRM 4.5 |
| 3 | +CiviHR is a complex system, with many moving parts. The code in this repository is just one of these parts. It's possible to create a new site manually, but, given the number of necessary steps, this a hard and time consuming task. For this reason, the best way to install CiviHR is by using one of the installation methods available: |
4 | 4 |
|
5 | | -> NOTE: CiviHR includes some significant changes to the nomal CiviCRM |
6 | | -> user-experience. As with any significant change or addition, CiviHR |
7 | | -> should be evaluated on a test/staging site before installing on a |
8 | | -> live/production site. |
| 5 | +## Using the civihr-installer script |
9 | 6 |
|
10 | | -## Download |
| 7 | +The [civihr-installer](https://github.com/compucorp/civihr-installer) script has a mininum set of requirements and it is a quick way to get CiviHR up and running. Please check its repository for more information on how to use it. |
11 | 8 |
|
12 | | -```bash |
13 | | -cd </path/to/extension/dir> |
14 | | -# (ex: $drupalroot/vendor/civicrm or $civiroot/tools/extensions or a custom-configed path) |
| 9 | +> Note: A site created with this script is not suited for development, as it will not include many tools and files required for this kind of work. If you're looking for that, the installation with buildkit is the way to go. |
15 | 10 |
|
16 | | -wget https://github.com/civicrm/civihr/archive/1.4.0.zip |
17 | | -unzip 1.4.0.zip |
18 | | -mv civihr-1.4.0 civihr |
19 | | -``` |
20 | | - |
21 | | -> NOTE: On some misconfigured systems, the "wget" command may display a warning |
22 | | -> like "ERROR: The certificate of `github.com' is not trusted." For a workaround, |
23 | | -> add the option "--no-check-certificate" or check out [this article](http://blog.55minutes.com/2012/01/fixing-https-certificate-errors-in-wget-and-ruby/). |
24 | | -
|
25 | | -## Install (Option A: Drush) |
| 11 | +## Using buildkit |
26 | 12 |
|
27 | | -If you have Drush installed, then you can enable all the extensions at once: |
| 13 | +[Buildkit](https://github.com/civicrm/civicrm-buildkit) is a collection of development tools for CiviCRM. Among these tools, there's `civibuild`, which can be used to quickly create new sites. To create a new CiviHR site, you can use the `hr17` build type: |
28 | 14 |
|
29 | | -```bash |
30 | | -cd /var/www/drupal |
31 | | -bash vendor/civicrm/civihr/bin/drush-install.sh --with-sample-data |
32 | 15 | ``` |
33 | | - |
34 | | -If you're familiar with different ways to call drush, then you can use the same |
35 | | -techniques with drush-install.sh, e.g. |
36 | | - |
37 | | -```bash |
38 | | -cd /var/www/drupal/vendor/civicrm/civihr |
39 | | -./bin/drush-install.sh --with-sample-data --root=/var/www/drupal |
40 | | - |
41 | | -or |
42 | | - |
43 | | -cd /var/www/drupal/sites/example.com |
44 | | -bash /var/www/drupal/vendor/civicrm/civihr/bin/drush-install.sh --with-sample-data |
| 16 | +$ civibuild create hr17 |
45 | 17 | ``` |
46 | 18 |
|
47 | | -Read the drush-install.sh for details. |
48 | | - |
49 | | -## Install (Option B: Manual) |
50 | | - |
51 | | -CiviHR includes over a dozen extensions. These can be activated piecemeal. |
52 | | -The following extensions provide the major features and may be activated |
53 | | -individually: |
54 | | - |
55 | | - * org.civicrm.hrbank: Bank Details |
56 | | - * org.civicrm.hrcareer: Career History |
57 | | - * org.civicrm.hrdemog: Extended Demographics |
58 | | - * org.civicrm.hremerg: Emergency Contacts |
59 | | - * org.civicrm.hrabsence: Absences |
60 | | - * org.civicrm.hrjobcontract: Job Contracts |
61 | | - * org.civicrm.hrmed: Medical and Disability |
62 | | - * org.civicrm.hrqual: Qualifications |
63 | | - * org.civicrm.hrreport: Reporting |
64 | | - * org.civicrm.hrstaffdir: Staff Directory |
65 | | - * org.civicrm.hrcase: Case |
66 | | - * org.civicrm.hrcaseutils: Case Utils |
67 | | - * org.civicrm.hrim: Instant messanger link |
68 | | - * org.civicrm.hrrecruitment: Recruitment |
69 | | - * org.civicrm.hrprofile: Profile |
70 | | - |
71 | | -Finally, these two extensions build on top of the others: |
72 | | - |
73 | | - * uk.co.compucorp.civicrm.hrsampledata: Generate random example data |
74 | | - * org.civicrm.hrui: Trim/revise CiviCRM UI for CiviHR users |
| 19 | +Please check the [civibuild documentation](https://docs.civicrm.org/dev/en/latest/tools/civibuild/) for more information on all the available params. |
0 commit comments