Setup

Clone

git clone git@github.com:ORCID/registry_vagrant.git

Make sure you have Vagrant 1.7.2 or later.
```
 vagrant -v
```

CD and install pluggin

 cd registry_vagrant
 vagrant plugin install vagrant-vbguest

Make sure your hosts file has dns entries for subdomains in /etc/hosts

  127.0.0.1       localhost
  127.0.0.1       api.localhost
  127.0.0.1       members.localhost
  127.0.0.1       pub.localhost

Running orcid_base

Run vagrant orcid_base
```
 vagrant up orcid_base
```

Running tomcat

Run vagrant tomcat
```
 vagrant up tomcat
```
Set up tunnels (remember other servers on 8080 shouldn't be running)
```
 ./ssh_tomcat_tunnels
```

Open new command line cd to project

 cd ~/git/registry_vagrant
 vagrant ssh tomcat
 sudo su - orcid_tomcat
 /home/orcid_tomcat/bin/scripts/deployment/deploy-app.py all

Running Nginx Shibboleth

Run vagrant nginx_shibboleth
```
  vagrant up nginx_shibboleth
```

Set host name:

 (Linux and OSX)
  export HOST_NAME="localhost"

 (Windows)
 set HOST_NAME="localhost"

Throw in nifty ssh hack to get around protected ports. Add 80 and 443 port forwards and 8080, 7777, 8888, 9999 reverse forward.
```
  ./ssh_nginx_shibboleth_tunnels
```
Fire up any other services, tomcat or drupal. You don't have to have all of them running, just the ones you want to access through nginx.

domain	proxies to port/path	description
localhost	8080/orcid-web or 8888/ or shib	about server and registry
api.localhost	8080/orcid-api-web	Registery API
members.localhost	9999/	members
pub.localhost	8080/orcid-pub-web	Registry Pub API

Hint: For tomcat you need to modify your VM arguments to support https and new domain:

    -Dorg.orcid.core.baseUri=https://localhost
    -Dorg.orcid.core.pubBaseUri=https://pub.localhost
    -Dorg.orcid.core.apiBaseUri=https://api.localhost

Running txgh

##Prerequisites

Create a Transifex account https://www.transifex.com/signin
Create a new Transifex project https://www.transifex.com/[account-name]/add/
Install the Transifex command line client http://docs.transifex.com/tutorials/client/#1-initialize-a-transifex-project

##(New Transifex projects only) Create the .tx/config file

Transifex requires a per project configuration file to store the project's details and the file-to-resource mappings. This file is stored in .tx/config of your project's root directory. This file can either be created manually, or automatically using the Transifex client. To create .tx/config for a new project using the Transifex client:

Clone the repository that contains the source language properties files
```
 git clone [repo]
```
Change directories into the repo that you just cloned
```
 cd ~/git/repo-name
```
Initialize the repo as a TXGH project, per http://docs.transifex.com/tutorials/client/#1-initialize-a-transifex-project
```
 tx init
```
When Transifex instance [https://www.transifex.com]: is displayed, press Enter This creates an empty .tx/config file.

Add each resource type to the .tx/config file, per http://docs.transifex.com/client/set/

 tx set --auto-local -r txgh-test.api 'i18n/api_<lang>.properties' --source-lang en --type UNICODEPROPERTIES --source-file i18n/api_en.properties --execute

 tx set --auto-local -r txgh-test.email 'i18n/email_<lang>.properties' --source-lang en --type UNICODEPROPERTIES --source-file i18n/email_en.properties --execute

 tx set --auto-local -r txgh-test.javascript 'i18n/javascript_<lang>.properties' --source-lang en --type UNICODEPROPERTIES --source-file i18n/javascript_en.properties --execute

 tx set --auto-local -r txgh-test.messages 'i18n/messages_<lang>.properties' --source-lang en --type UNICODEPROPERTIES --source-file i18n/messages_en.properties --execute

Verify that the resources have been added to .tx/config

 cat .tx/config

 [main]
 host = https://www.transifex.com

 [txgh-test.api]
 file_filter = i18n/api_<lang>.properties
 source_file = i18n/api_en.properties
 source_lang = en
 type = UNICODEPROPERTIES

 [txgh-test.messages]
 file_filter = i18n/messages_<lang>.properties
 source_file = i18n/messages_en.properties
 source_lang = en
 type = UNICODEPROPERTIES

 [txgh-test.email]
 file_filter = i18n/email_<lang>.properties
 source_file = i18n/email_en.properties
 source_lang = en
 type = UNICODEPROPERTIES

 [txgh-test.javascript]
 file_filter = i18n/javascript_<lang>.properties
 source_file = i18n/javascript_en.properties
 source_lang = en
 type = UNICODEPROPERTIES

Commit and push the changes to Github
Push the project files to Transifex
```
 tx push -s -t
```
Edit the github_repo variable in puppet/manifests/txgh_default.pp to include the name of your repo.
```
 github_repo => 'ORCID/txgh_test',
```

##Create the txgh.yml configuration file

NOTE: Puppet will not run correctly without this file configured

Copy puppet/modules/orcid_txgh/example-txgh.yml in the same directory and name it txgh.yml

 cp puppet/modules/orcid_txgh/files/example-txgh.yml puppet/modules/orcid_txgh/files/txgh.yml

Edit txgh.yml to add the credential information for your Github repo and Transifex project

 vim puppet/modules/orcid_txgh/files/txgh.yml

 txgh:
     github:
         repos:
            #full github repo name including username
            githubuser/repo-name:
                 #your github username
                 api_username: githubuser
                 #github personal api token - see https://github.com/blog/1509-personal-api-tokens
                 api_token: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
                 #get this from the project URL when logged into transifex web UI (project URL like: https://www.transifex.com/account-name/transifex-project-id)
                 push_source_to: transifex-project-id
     transifex:
         projects:
            #transifex project id - same as push_source_to value above
            transifex-project-id:
                 #tx.config file location 
                 tx_config: "/home/orcid_txgh/txgh-master/config/tx.config"
                 #transifex username
                 api_username: transifexuser
                 #transifex password - same as web UI password
                 api_password: XXXXXXXXXXXXXXX
                 #full github repo name including username - same as repo name in repos section above
                 push_translations_to: githubuser/repo-name
                 #(optional)specifies which status should trigger push from transifex to github - translated or reviewed
                 push_trigger: reviewed

##Start the TXGH server

Run vagrant txgh
```
 vagrant up txgh
```
SSH to txgh machine
```
 vagrant ssh txgh         
```
Start ngrok to expose localhost webhook port publicly (for local dev only)
```
 ./ngrok http 9292
```

This will generate an ngrok URL, which will be used to configure Github and Transifex webhooks

    Forwarding      https://ebefeec3.ngrok.io -> localhost:9292

Start the txgh server

 cd /home/orcid_txgh/txgh-master
 rackup -o 0.0.0.0

##Configure Github webhook

Navigate to https://github.com/ORCID/[repository]/settings/hooks
Click Add Webhook

Configure the webhook settings:

 * Payload URL: https://ebefeec3.ngrok.io/hooks/github
 * Content type: application/x-www-form-urlencoded
 * Secret: Leave blank
 * Which events: Just the push event

Click the Active checkbox, then click Add Webhook
Github will send a test to your webhook endpoint - this should return a 200 response

##Configure Transifex webhook

Navigate to https://www.transifex.com/orcid-inc-1/[projectslug]/settings

In the Webhook URL field, enter

 http://ebefeec3.ngrok.io/hooks/transifex

Click Save Project

##Test Github/Transifex sync

Ensure that both ngrok and txgh are running
Make a change to your local git repo
Commit and push your changes to the Github remote
Verify webhook received and commit pushed to Transifex in TXGH console output
Log into Transifex to verify that project resources were updated

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Setup

Running orcid_base

Running tomcat

Running Nginx Shibboleth

Running txgh

Files

README.md

Latest commit

History

README.md

File metadata and controls

Setup

Running orcid_base

Running tomcat

Running Nginx Shibboleth

Running txgh