{"id":133,"date":"2013-04-12T17:45:54","date_gmt":"2013-04-12T17:45:54","guid":{"rendered":"https:\/\/www.peopleperhour.com\/engineering\/?p=133"},"modified":"2013-04-12T17:45:54","modified_gmt":"2013-04-12T17:45:54","slug":"yiises-setup-guide","status":"publish","type":"post","link":"https:\/\/www.peopleperhour.com\/engineering\/2013\/04\/12\/yiises-setup-guide\/","title":{"rendered":"YiiSES Setup guide"},"content":{"rendered":"

We wanted to build a marketing email application (which we are calling “MailChap”) and since we are a Yii shop I figured before we started, we should try the YiiSES<\/a> module. Setup was a little tricky so I documented it here in case it’s useful to someone else.<\/p>\n

These instructions apply to a Ubuntu machine with a LAMP stack installed. For reference, we’re using a “m1.small” EC2 instance.<\/p>\n

Set up YiiSES<\/h3>\n
    \n
  1. Create the Apache document root:
    \nsudo mkdir \/var\/www\/yiises;cd \/var\/www\/yiises<\/tt><\/li>\n
  2. Clone the yiiboilerplate<\/a> repository: sudo git clone git:\/\/github.com\/clevertech\/YiiBoilerplate.git \/var\/www\/yiises<\/tt>\n<\/li>\n
  3. Edit the config files to set Yii up with a mysql connection:\n
      \n
    1. sudo vim common\/config\/params-local.php<\/tt>
      \n 'db.name' => 'mailchap',
      \n 'db.connectionString' => 'mysql:host=[your_db_url];dbname=yiises',
      \n 'db.username' => 'mailchap_webapp',
      \n 'db.password' => '[your_password]',
      \n<\/tt><\/li>\n
    2. sudo vim console\/config\/main.php<\/tt> – uncomment db section.\n<\/li>\n
    3. sudo vim backend\/config\/main.php<\/tt> – uncomment frontend alias line, and db section.\n<\/li>\n
    4. sudo vim frontend\/config\/main.php<\/tt> – uncomment db section.\n<\/li>\n<\/ol>\n<\/li>\n
    5. Run the script that “deploys” the environment that we call “local”: sudo .\/runpostdeploy local no-migrate<\/tt><\/li>\n
    6. Run the yii migrations to create the users table: sudo .\/yiic migrate<\/tt><\/li>\n
    7. Setup 2 DNS rules (e.g. using AWS Route53) for this app:\n
        \n
      1. Make “yiises.yourdomain.com” a DNS Alias for the instance IP. Test it with by browsing to \u200b<\/span>http:\/\/yiises.yourdomain.com\/<\/a><\/li>\n
      2. Make “admin.yiises.yourdomain.com” a DNS Alias for the instance IP. Test it with by browsing to \u200b<\/span>http:\/\/admin.yiises.yourdomain.com\/<\/a><\/li>\n<\/ol>\n<\/li>\n
      3. Set up Apache:\n
          \n
        1. sudo vim \/etc\/apache2\/sites-available\/yiises:
          \n<VirtualHost *:80><\/p>\n

          ServerName yiises.yourdomain.com
          \n DocumentRoot \/var\/www\/yiises\/frontend\/www
          \n AddDefaultCharset UTF-8<\/p>\n

          <Directory \/var\/www\/yiises\/frontend\/www>
          \n Options FollowSymLinks
          \n <\/Directory><\/p>\n

          ErrorLog \/var\/log\/apache2\/yiises-error.log
          \n CustomLog \/var\/log\/apache2\/yiises-access.log combined
          \n<\/VirtualHost>
          \n<VirtualHost *:80><\/p>\n

          ServerName admin.yiises.yourdomain.com
          \n DocumentRoot \/var\/www\/yiises\/backend\/www
          \n AddDefaultCharset UTF-8<\/p>\n

          <Directory \/var\/www\/yiises\/backend\/www>
          \n Options FollowSymLinks
          \n <\/Directory><\/p>\n

          ErrorLog \/var\/log\/apache2\/yiises-error.log
          \n CustomLog \/var\/log\/apache2\/yiises-access.log combined
          \n<\/VirtualHost>
          \n<\/tt><\/li>\n<\/ol>\n<\/li>\n

        2. Enable the rewrite module and the new vhost:
          \nsudo a2enmod rewrite
          \nsudo a2ensite yiises
          \nsudo service apache2 reload
          \n<\/tt><\/li>\n
        3. Check it works: \u200b<\/span>http:\/\/yiises.yourdomain.com\/<\/a> you should see:
          \n
          \n

          \nThis is index view file…<\/em>\n<\/p>\n<\/blockquote>\n<\/li>\n

        4. A less boring page should be the admin backend: http:\/\/admin.yiises.yourdomain.com\/<\/a><\/li>\n
        5. Install the yiises module:\n
            \n
          1. cd \/var\/www\/yiises\/backend\/modules<\/tt>
            \nsudo wget https:\/\/github.com\/clevertech\/YiiSES\/archive\/master.zip
            \nsudo unzip master.zip
            \nsudo rm master.zip
            \n<\/tt><\/li>\n
          2. Rename to “ses”: sudo mv YiiSES-master ses<\/tt>\n<\/li>\n
          3. Move a command from the module into the correct place: sudo cp ses\/commands\/CampaignCommand.php ..\/..\/console\/commands\/<\/tt><\/li>\n
          4. Declare the module in the backend config
            \nsudo vim backend\/config\/main-local.php
            \nAdd:
            \n 'modules' => array(
            \n 'ses'=>array('password'=>'clevertech',),
            \n ),
            \n<\/tt><\/li>\n<\/ol>\n<\/li>\n
          5. Set the SES params that the module needs:\n
              \n
            1. In the AWS SES console, Verify a email address.<\/li>\n
            2. Setup a IAM user called “MailChap-app” and give it access to SES. Note down the creds for the next step.<\/li>\n
            3. Add the creds to the config: sudo vim common\/config\/params-local.php<\/tt>:
              \n'ses.aws.key' =>'[your-key]',
              \n'ses.aws.secret' =>'[your-secret]',
              \n'ses.aws.verifiedEmail'=>'[your-email]',
              \n'ses.aws.test.email' =>'[your-email]',
              \n'ses.from.name' =>'MailChap App',
              \n<\/tt><\/li>\n<\/ol>\n<\/li>\n
            4. Run the migrations for yiises:\n
                \n
              1. Move the migration from the module into the correct place: sudo cp ses\/migrations\/m120809_075915_ses_initial_migration.php ..\/..\/console\/migrations\/<\/tt>\n<\/li>\n
              2. Edit the migration file so the subscribed<\/tt> field is added to the users<\/tt> table (because this is not in the default from the yiiboilerplate).\n<\/li>\n
              3. Run the migration: sudo .\/yiic migrate<\/tt>\n<\/li>\n<\/ol>\n<\/li>\n
              4. Hit \u200b<\/span>http:\/\/admin.yiises.yourdomain.com\/ses<\/a> – The password is as above “clevertech”\n<\/li>\n
              5. Once you send some emails, you can view the sending stats at \u200b<\/span>http:\/\/admin.yiises.yourdomain.com\/ses\/amazon\/manage\/<\/a>\n<\/li>\n<\/ol>\n

                Phew! It’s not too hard, unless you never used yiiboilerplate<\/a> before (like me).<\/p>\n","protected":false},"excerpt":{"rendered":"

                We wanted to build a marketing email application (which we are calling “MailChap”) and since we are a Yii shop I figured before we started, we should try the YiiSES module. Setup was a little tricky so I documented it here in case it’s useful…<\/p>\n","protected":false},"author":40,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[21],"tags":[38,22],"class_list":["post-133","post","type-post","status-publish","format-standard","hentry","category-aws","tag-aws","tag-ses"],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/p2CA4w-29","jetpack_likes_enabled":true,"jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/www.peopleperhour.com\/engineering\/wp-json\/wp\/v2\/posts\/133","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.peopleperhour.com\/engineering\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.peopleperhour.com\/engineering\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.peopleperhour.com\/engineering\/wp-json\/wp\/v2\/users\/40"}],"replies":[{"embeddable":true,"href":"https:\/\/www.peopleperhour.com\/engineering\/wp-json\/wp\/v2\/comments?post=133"}],"version-history":[{"count":29,"href":"https:\/\/www.peopleperhour.com\/engineering\/wp-json\/wp\/v2\/posts\/133\/revisions"}],"predecessor-version":[{"id":162,"href":"https:\/\/www.peopleperhour.com\/engineering\/wp-json\/wp\/v2\/posts\/133\/revisions\/162"}],"wp:attachment":[{"href":"https:\/\/www.peopleperhour.com\/engineering\/wp-json\/wp\/v2\/media?parent=133"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.peopleperhour.com\/engineering\/wp-json\/wp\/v2\/categories?post=133"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.peopleperhour.com\/engineering\/wp-json\/wp\/v2\/tags?post=133"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}