teracy-blog

Teracy's official blog at http://blog.teracy.com

Getting Started

• Set up teracy-dev if not yet, follow: http://dev.teracy.org/docs/develop/getting_started.html

• Fork this repo into your github account

• Clone the forked repo into ~/teracy-dev/workspace directory:

  $ cd ~/teracy-dev/workspace/
  $ git clone <your_forked_repository_here> teracy-blog
  $ cd teracy-blog
  $ git remote add upstream [email protected]:teracyhq/blog.git

Note: You need to fetch the latest changes of teracy-blog before going to the next step. Please see the details at http://dev.teracy.org/docs/develop/workflow.html.

How to work in dev mode

• Make sure your vagrant_config_override.json has the following config:

{
  "provisioners": [{
    "_id": "0",
    "json": {
      "teracy-dev": {
        "proxy": {
          "container": {
            "enabled": true
          }
        }
      }
    }
  }],
  "plugins": [{
    "_id": "2",
    "options": {
      "aliases": [ // should add to the existing aliases if any
        "dev.blog.teracy.dev", "review.blog.teracy.dev", "blog.teracy.dev"
      ]
    }
  }]
}

• $ vagrant reload --provision and $ vagrant hostmanager to make sure everything is updated.

• Start:

  Keep the first terminal window and let the file watching keep running.

  Open the second terminal window:

  $ cd ~/teracy-dev
  $ vagrant ssh
  $ ws
  $ cd teracy-blog
  $ docker-compose pull && docker-compose up -d dev

  Open dev.blog.teracy.dev to preview on local.

  Need to make sure the blog build completed before previewing it. Use the command below:

  $ docker-compose logs -f

  Press Ctrl + c to stop following reviewing the logs.

• Update new changes:

  Update new changes, save the changes, and run the command below:

  $ docker-compose exec dev rake generate

  Refresh the browser to see the new changes.

• Stop working:

  $ docker-compose stop && docker-compose rm -f

How to review others' work and PRs (pull requests)

To review work and PRs submitted by others, for example, with hoatle/teracy-blog:tasks-BLOG-101-travis-docker-hub, run the following command:

$ docker-compose stop review && docker-compose rm -f review
$ export DOCKER_IMAGE_REVIEW=hoatle/teracy-blog:tasks-BLOG-101-travis-docker-hub && \
  docker-compose pull review && \
  docker-compose up review

And open review.blog.teracy.dev to review the changes on local dev.

Press Ctrl + c to stop reviewing (stop docker run)

How to run in prod mode

Run in the prod mode from official distributed Docker image:

$ docker-compose pull && docker-compose up -d prod

Then open blog.teracy.dev to see the static blog site served by nginx.

How to build the prod Docker image

First, use the teracy/blog:dev_latest image to generate static content:

$ docker-compose run --rm dev

And then:

$ docker-compose build prod

travis-ci configuration

You just need to configure travis-ci only one time. After each travis-ci build, new Docker images are pushed, we can review your work (PR) by running the Docker images instead of fetching git code and build it on local ourselves.

Here are things you need to do:

• Register your account at https://hub.docker.com

• Register your account at travis-ci.org

• Enable teracy-blog repository on travis-ci (for example: https://travis-ci.org/hoatle/teracy-blog)

• Fill in the following environment variables settings for teracy-blog travis-ci project by following: https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings. In the Name and Value fields, please add the info below correlatively:

  • Fill in "DOCKER_USER" into the Name field and your Docker username or organization into the Value field. For example: teracy, hoatle or hoavt.
  • Fill in "DOCKER_REPO" into the Name field and your Docker image repo name into the Value field. For example: "teracy-blog"
  • Fill in "DOCKER_USERNAME" into the Name field and your Docker username into the Value field.
  • Fill in "DOCKER_PASSWORD" into the Name field and your Docker password into the Value field.

And you're done!

Tips:

• How to generate content faster when previewing instead of waiting:

  $ docker-compose exec dev rake generate

• How to access into the container ssh session:

  $ docker-compose exec dev /bin/bash
  app@a4e5c4766cd3:/opt/app$