Update README
parent
6f0555f279
commit
d2c120c052
27
README.md
27
README.md
|
@ -1,24 +1,30 @@
|
|||
# CCE Search Ansible Setup
|
||||
|
||||
## Frontend Server (cce.ebookfoundation.org)
|
||||
# Frontend Server (cce.ebookfoundation.org)
|
||||
|
||||
### Pre-requisites
|
||||
1. Install `ansible` on your local machine
|
||||
2. Ensure you have obtained the SSH key for the server
|
||||
3. Ensure Python 3.7 and pip3 are installed on the server you wish to deploy to
|
||||
|
||||
### Deploying
|
||||
## Complete Playbooks
|
||||
|
||||
### Updating and redeploying
|
||||
|
||||
Once new changes have been added to the master branch of the [frontend repo](https://github.com/EbookFoundation/cce-search-prototype), run the `update-frontend-prod` playbook:
|
||||
```
|
||||
$ ansible-playbook -i hosts update-frontend-prod.yml --key-file="/path/to/key/on/your/machine"
|
||||
```
|
||||
|
||||
## In-progress Playbooks
|
||||
|
||||
### Initial bootstrapping and deployment
|
||||
|
||||
To deploy, run the `setup-frontend-prod` playbook from within the directory containing this repository:
|
||||
```
|
||||
$ ansible-playbook -i hosts setup-frontend-prod.yml --key-file="/path/to/key/on/your/machine"
|
||||
```
|
||||
|
||||
### Updating
|
||||
Once new changes have been added to the master branch of the [frontend repo](https://github.com/EbookFoundation/cce-search-prototype), run `update-frontend-prod` playbook:
|
||||
```
|
||||
$ ansible-playbook -i hosts update-frontend-prod.yml --key-file="/path/to/key/on/your/machine"
|
||||
```
|
||||
|
||||
### Manually renewing HTTPS cert
|
||||
If Certbot does not automatically renew the HTTPS certificate, run the `refresh-frontend-cert` playbook:
|
||||
```
|
||||
|
@ -28,6 +34,5 @@ $ ansible-playbook -i hosts refresh-frontend-cert.yml --key-file="/path/to/key/o
|
|||
### TODO
|
||||
1. Complete todos from setup-frontend-prod.yml
|
||||
2. Complete refresh-frontend-cert.yml
|
||||
3. Complete update-frontend-prod.yml
|
||||
4. Automate installation of Python 3.7 and pip3
|
||||
5. Setup Ansible Vault to handle keys
|
||||
3. Automate installation of Python 3.7 and pip3
|
||||
4. Setup Ansible Vault to handle keys
|
Loading…
Reference in New Issue