This repo holds the Docker files for setting up production and development environments.

• NOTE: The plugins and themes required for the site are not actively maintained or supported by Scholars' Lab, but you are free to fork and change, and submit pull requests.

• Clone the repository into the appropriate place, ex /var/www/rhythmofrussian.lib.virginia.edu
  • git clone https://github.com/scholarslab/rhythm-of-russian.git rhythmofrussian.lib.virginia.edu
• Change into the 'rhythm-of-russian' folder.
  • cd rhythmofrussian.lib.virginia.edu
• Clone the plugins and theme repos into your working directory
  • git clone https://github.com/czthomas/prosody_plugin.git
  • git clone https://github.com/czthomas/prosody_theme.git
  • git clone https://github.com/Seravo/wp-custom-bulk-actions.git
• Create a '.env' file with the following variables

  MYSQL_ROOT_PASSWORD=some_great_password
  MYSQL_USER=wordpress_user
  MYSQL_PASSWORD=wordpress_password
  MYSQL_DATABASE=wordpress
  WORDPRESS_DB_HOST=rhythm_mysql:3306
  WORDPRESS_TABLE_PREFIX=wp_
  

  • NOTE the following about each line:
    • MYSQL_DATABASE, WORDPRESS_DB_HOST, WORDPRESS_TABLE_PREFIX must be as written.
    • The first three lines can be whatever.
• Copy the uploads directory from the old RoR site
  • scp -r old.rhythm.site:/path/to/wp/wp-content/uploads uploads
• Make a dump of the old RoR database. Make a folder called 'initial_sql', and put the file in there.
  • Make sure to name it "rhythm.sql".
• Note the 'Dockerfile'. This is needed so that the xsl module is enabled in the WordPress image. This creates a separate docker image that is used instead of the one supplied by WordPress
• Uncomment the 'initial_sql' line in the docker-compose.yml file.
  • ./initial_sql/rhythm.sql:/docker-entrypoint-initdb.d/rhythm.sql
• Make sure the permissions on all files and folders are correct.
  • files should be 644
    • find . -type f -exec chmod 664 '{}' \;
  • folders should be 755 (with the s bit set)
    • find . -type d -exec chmod ug=rwx,g+s,o=rx '{}' \;
• Start the container with docker-compose, with -d flag to start docker-compose as a background process
  • docker-compose up -d
  • To test the set up and check for any errors, run the above command without the "-d" flag.
    • After everything looks good, you can stop the docker process with
      • Ctrl-c
    • then stop all docker containers with the following command before restarting (and delete the local Docker volumes)
      • docker-compose down --volumes
• Comment out the line with 'initial_sql' in the docker-compose.yml file so it is not loaded on subsequent restarts (potentially overwriting changes made to the website).
  • #./initial_sql/rhythm.sql:/docker-entrypoint-initdb.d/rhythm.sql

It will be necessary to restart Docker when upgrading the WordPress version, or the MySQL version.

• While in the project folder (/var/www/rhythmofrussian.lib.virginia.edu), shutdown docker
  • docker-compose down
• Make sure to comment out the line with 'initial_sql', if not done already.
  • #./initial_sql/rhythm.sql:/docker-entrypoint-initdb.d/rhythm.sql

• The docker-compose file already has specified to use the latest version of WordPress, so just restart.
  • docker-compose up -d

• Specify the version of MySQL to use in the docker-compose.yml file.
  • image: mysql:5.7
• Then restart Docker Compose
  • docker-compose up -d

To get the updates to the theme and plugin, just pull them down from the GitHub repo. No need to restart Docker Compose.

• While in the folder for the theme or plugin (ex. /var/www/rhythmofrussian.lib.virginia.edu/wp-content/plugins/prosody_plugin):
  • git pull

It may be necessary, or desireable to create a dump of the production (or development) database. This can be used to seed your development set up, or to revert the production instance to a known good version. A BASH script in the 'scripts' folder makes this super easy. Just run this from the command line, in the main project directory (the same level as the 'scripts' folder).

• Double check that the script is executable
• This script will only work if the container is actively running.
• Then run
  • ./scripts/dump-docker-db.sh

This script will create a new .sql file in the 'initial_sql' folder with the current date-stamp as the file name. This folder is automatically created when docker-compose is run. This file can then be used in the docker-compose.yml file as the initial sql file to seed the database (replace the existing name of the file on the line that has 'initial_sql', with the version you just created).

• This repo is for creating a development environment for working on the http://rhythmofrussian.lib.virginia.edu website (which is a clone of http://rhythmofrussian.lib.virginia.edu)

• Docker: https://www.docker.com/community-edition#/download
• Git: https://git-scm.com/downloads
• Terminal

• Clone the rhythm-of-russian repository
  • git clone https://github.com/scholarslab/rhythm-of-russian.git
• Change into folder.
  • cd rhythm-of-russian
• Clone plugins and theme
  • Clone the plugin folder
    • git clone https://github.com/czthomas/prosody_plugin.git
  • Clone the theme folder
    • git clone https://github.com/czthomas/prosody_theme.git
  • Seravo wp-custom-bulk-actions
    • git clone https://github.com/Seravo/wp-custom-bulk-actions.git
• Create a '.env' file with the following variables

  MYSQL_ROOT_PASSWORD=some_great_password
  MYSQL_USER=wordpress_user
  MYSQL_PASSWORD=wordpress_password
  MYSQL_DATABASE=wordpress
  WORDPRESS_DB_HOST=db:3306
  WORDPRESS_TABLE_PREFIX=wp_
  PORTS=80:80
  

  • NOTE the following about each line:
    • MYSQL_DATABASE, WORDPRESS_DB_HOST, WORDPRESS_TABLE_PREFIX must be as written.
    • PORTS depends on production or development. Development should have 80 for the first value (left side of colon).
    • The first three lines can be whatever.
• Copy the uploads directory from the production site
  • scp -r rhythmofrussian.lib.virginia.edu:/path/to/wp/wp-content/uploads uploads
• Make a dump of the current RoR database (see above step MySQL dump).
• Make a folder called 'initial_sql', and put the file in there.
  • Make sure to name it "rhythm.sql", or change the name in the docker-compose.yml file (noted below).
• Note the 'Dockerfile'. This is needed so that the xsl module is enabled in the WordPress image. This creates a separate docker image that is used instead of the one supplied by WordPress
• Uncomment the 'initial_sql' line in the docker-compose.yml file.
  • ./initial_sql/rhythm.sql:/docker-entrypoint-initdb.d/rhythm.sql
• Start the container with docker-compose
  • docker-compose up
• After Docker Compose is running the container and there are no errors, then comment out the line with 'initial_sql' in the docker-compose.yml file.
  • #./initial_sql/rhythm.sql:/docker-entrypoint-initdb.d/rhythm.sql
• Change your '/etc/hosts' file to direct http://rhythmofrussian.lib.virginia.edu to your local machine
  • For Mac and Linux
    • Add this line to the '/etc/hosts' file, you will need to be root or use sudo
      • 127.0.0.1 rhythmofrussian.lib.virginia.edu
  • For Windows machines (from https://gist.github.com/zenorocha/18b10a14b2deb214dc4ce43a2d2e2992)
    • For Windows 10 and 8
      • Press the Windows key.
      • Type Notepad in the search field.
      • In the search results, right-click Notepad and select Run as administrator.
      • From Notepad, open the following file: c:\Windows\System32\Drivers\etc\hosts
      • Make the necessary changes to the file. Add the line
        • 127.0.0.1 rhythmofrussian.lib.virginia.edu
      • Click File > Save to save your changes.
    • For Windows 7 and Vista
      • Click Start > All Programs > Accessories.
      • Right-click Notepad and select Run as administrator.
      • Click Continue on the Windows needs your permission UAC window.
      • When Notepad opens, click File > Open.
      • In the File name field, type C:\Windows\System32\Drivers\etc\hosts.
      • Click Open.
      • Make the necessary changes to the file. Add the line
        • 127.0.0.1 rhythmofrussian.lib.virginia.edu
      • Click File > Save to save your changes.
    • For Windows NT, Windows 2000, and Windows XP
      • Click Start > All Programs > Accessories > Notepad.
      • Click File > Open.
      • In the File name field, type C:\Windows\System32\Drivers\etc\hosts.
      • Click Open.
      • Make the necessary changes to the file. Add the line
        • 127.0.0.1 rhythmofrussian.lib.virginia.edu
      • Click File > Save to save your changes.
• With the ports set at '80:80' and the change to the /etc/hosts file, the website is viewable at http://rhythmofrussian.lib.virginia.edu
• When done testing, remove the line from '/etc/hosts' file.

It may be necessary to remove the images created by running docker-compose. Docker Compose will create the following images:

• rhythm_wp

• wordpress (latest version)

• mysql (version 5.7)

• To fully remove these images, first shut down the containers and remove the local volume:

  • docker-compose down --volumes

• Get the list of images with:

  • docker images

    [Results will look like this]
      REPOSITORY          TAG                 IMAGE ID            CREATED             SIZE
      rhythm_wp           0.1                 5e42a88dda96        1 hour ago          522MB
      wordpress           latest              652d1ff3db63        1 hour ago          407MB
      mysql               5.7                 0d16d0a97dd1        1 hour ago          372MB
    
    

• Then remove the images (where <ID> is the unique IMAGE ID for the rhythm_wp, wordpress and mysql images, these should be the most recent three created):

  • docker rmi <ID> <ID> <ID>

• Based off of the github-flow workflow, see http://scottchacon.com/2011/08/31/github-flow.html
• Github Flow
  • master branch: The main stable branch. All feature and work branches should be off of this branch, and merged back into this branch.
  • production branch: When a good stable release is achieved, merge from the main to production with a tag. Once pushed to GitHub, Travis CI will automatically push tagged branches to npm.js.
  • working/feature branch: When making changes or adding a feature, or fixing a bug, create a branch with a descriptive name off of the master branch. This is also pushed to GitHub and pushed to constantly. Any branch not master or production is something being worked on. When changes are done, submit a pull request. Others can add to a conversation about the changes, and any subsequent changes can be made before merging into master.