README.md
author ymh <ymh.work@gmail.com>
Wed, 24 Apr 2019 02:26:02 +0200
changeset 5 3b60692effa9
parent 2 8bfef8029c17
child 6 36381334b11e
permissions -rw-r--r--
clean docker compose file and move data management in readme
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
# Recherchecontributive.org Website
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
This project is the website for recherchecontributive.org.
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
## Getting Started
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
### Prerequisites
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
What things you need to install the software and how to install them
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
  - docker
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
  - docker-compose
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
  - A code editor
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
### Installing
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
2
8bfef8029c17 Correct README and add missing wp-config file
ymh <ymh.work@gmail.com>
parents: 0
diff changeset
    20
Build docker images:
8bfef8029c17 Correct README and add missing wp-config file
ymh <ymh.work@gmail.com>
parents: 0
diff changeset
    21
8bfef8029c17 Correct README and add missing wp-config file
ymh <ymh.work@gmail.com>
parents: 0
diff changeset
    22
```
8bfef8029c17 Correct README and add missing wp-config file
ymh <ymh.work@gmail.com>
parents: 0
diff changeset
    23
$ docker-compose build
8bfef8029c17 Correct README and add missing wp-config file
ymh <ymh.work@gmail.com>
parents: 0
diff changeset
    24
```
8bfef8029c17 Correct README and add missing wp-config file
ymh <ymh.work@gmail.com>
parents: 0
diff changeset
    25
0
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
Launch the project
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
$ docker-compose up
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    31
or
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
$ docker-compose up -d
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    36
import data.
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    39
$ docker-compose exec -T wp /var/www/html/vendor/bin/wp --allow-root db import - < /path/to/recherchecontributive_dbase.sql
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    40
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    41
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    42
Replace strings in database:
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    43
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    44
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    45
docker-compose exec wp /var/www/html/vendor/bin/wp --allow-root search-replace https://recherchecontributive.org http://localhost:8080
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    46
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    47
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    48
Import media files:
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    49
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    50
$ tar -C src/web/app/ zxf /path/to/recherchecontributive_media.tar.gz 
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    51
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    52
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    53
Navigate to http://localhost:8080.
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    54
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    55
## Data management
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    56
5
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
    57
**!! BEWARE !!**: Do not launch the `docker-compose down` command before exporting data. This command delete the `db` container's data volume end therefore delete the database.
0
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    58
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    59
### Export database
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    60
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    61
$ docker-compose exec wp /var/www/html/vendor/bin/wp --allow-root db export --add-drop-table - > recherchecontributive_dbase_2019-04-19.sql
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    62
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    63
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    64
### Export media
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    65
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    66
$ tar zcf recherchecontributive_media_2019-04-19.tar.gz -C src/web/app/ uploads
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    67
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    68
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    69
### Import database
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    70
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    71
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    72
$ docker-compose exec -T wp /var/www/html/vendor/bin/wp --allow-root db import - < recherchecontributive_dbase_2019-04-19.sql
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    73
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    74
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    75
If needed do a search replace after this to update the site urls:
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    76
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    77
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    78
$ docker-compose exec wp /var/www/html/vendor/bin/wp --allow-root search-replace https://recherchecontributive.org http://localhost:8080
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    79
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    80
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    81
Or change the administration password
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    82
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    83
$ docker-compose exec -T wp /var/www/html/vendor/bin/wp --allow-root user update admin --prompt=user_pass
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    84
```
800e4a6ab128 First commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    85
5
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
    86
## Deployment
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
    87
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
    88
TODO...
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
    89
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
    90
## Built With
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
    91
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
    92
* [Wordpress](https://wordpress.org/) - The CMS used
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
    93
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
    94
## Versioning
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
    95
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
    96
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://www.iri.centrepompidou.fr/dev/hg/recherchecontributive.org/tags). 
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
    97
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
    98
## Authors
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
    99
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
   100
* **Yves-Marie Haussonne** - *Initial work*
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
   101
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
   102
## License
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
   103
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
   104
This project is licensed under the CecCill License - see the [LICENSE.md](LICENSE.md) file for details
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
   105
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
   106
## Acknowledgments
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
   107
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
   108
* Hat tip to anyone whose code was used
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
   109
* Wordpress: https://wordpress.org/
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
   110
* Bedrock: https://roots.io/bedrock
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
   111
* Docker for local wordpress development: https://urre.me/writings/docker-for-local-wordpress-development/
3b60692effa9 clean docker compose file and move data management in readme
ymh <ymh.work@gmail.com>
parents: 2
diff changeset
   112