autonomic-cooperative/civicrm-confdump
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
naomi 2022-02-25 08:50:14 +00:00
parent 27bd1d835b
commit 555b04f18e
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,9 +1,14 @@
- Needs working local CiviCRM from caat-crm-installer
- Install pre-dependencies for MySQL client https://pypi.org/project/mysqlclient/ (on dpkg based linux: `sudo apt install python3-dev default-libmysqlclient-dev build-essential`)
- In confdump path, `virtualenv confdump.venv`
- Load the virtualenv `. confdump.venv/bin/activate`
- Install pre-dependencies for MySQL client https://pypi.org/project/mysqlclient/ (on dpkg based linux: `sudo apt install python3-dev default-libmysqlclient-dev build-essential`)
- Install requirements `pip -i requirements.txt`
- Fill out example.env for the production, test or development server you'll retrieve the data from.
- Install requirements `pip install -r requirements.txt`
- `cp example.env .env`
- Edit `.env` and add creds for the production, test or development server you'll retrieve the data from.
- Execute dump to retrieve base data: `env $(cat example.env) python ./confdump.py dump -o mydata INSTANCEPATH` where INSTANCEPATH is something like https://crm.dev.caat.org.uk/.
- Load data into running local instance with: `python confdump.py mysql -i mydata/ -p 63306`
- Clear the cache in CiviCRM from the caat-crm-installer directory with `make shell`, and then inside `cd /app; ./vendor/bin/drush cc all`
- **IMPORTANT!!** - If you sourced the data from live, you must delete the `.env` file or delete the creds from inside it. If you leave them in it will negate the whole purpose of having this conf dump utility, which is to provide a way of creating a local site without any sensitive data.
- If your civicrm is in a docker container, load data into running local instance with: `confdump.py mysql -i mydata/ -p 63306`
- Otherwise use `confdump.py mysql -i mydata/ --host=<host> --db=<db> --user=<user> --password=<password>`
- Clear the cache in CiviCRM:
* DOCKER: `make shell`, and then inside the shell `cd /app; ./vendor/bin/drush cc all`
* NORMAL: `cd web; vendor/bin/drush cc all`