Production Configuration

Heroku is the easiest way to deploy Chaskiq. There are two main modes on which you can deploy the application; the first way is using the <a href="https://heroku.com/deploy?template=https://github.com/chaskiq/chaskiq/tree/master">Heroku button</a>, this will not require any local installation and will handle all the heavy lifting for you.The second way is cloning the repo and installing it through the Heroku client. Let&#x27;s dig into it.<h3 class="graf graf--h4">TL;DR, Full tutorial Video:</h3><figure class="graf--figure graf--iframe graf--first"><div class="iframeContainer">&lt;iframe src=&quot;https://www.loom.com/embed/67f6b45057f347fca4ac4c2b88f6b47a&quot; frameborder=&quot;0&quot; width=&quot;1124&quot; height=&quot;843&quot; webkitallowfullscreen mozallowfullscreen allowfullscreen&gt;&lt;/iframe&gt;</div><figcaption class="imageCaption"><div class="public-DraftStyleDefault-block public-DraftStyleDefault-ltr">https://www.loom.com/share/67f6b45057f347fca4ac4c2b88f6b47a</div></figcaption></figure><h2 class="graf graf--h3">Introduction</h2>This tutorial will have you deploying a Ruby app in minutes. Hang on for a few more minutes to learn how it all works so that you can make the most out of Heroku. The tutorial assumes that you have:a free <a href="https://signup.heroku.com/dc">Heroku account</a>.Ruby 3.0.3 installed locally - see the installation guides for Ruby and Rails on <a href="http://guides.railsgirls.com/install#setup-for-os-x">OS X</a>, <a href="http://guides.railsgirls.com/install#setup-for-windows">Windows</a>, and <a href="http://guides.railsgirls.com/install#setup-for-linux">Linux</a>.<a href="http://bundler.io/">Bundler</a> installed locally - run <code>gem install bundler</code>.<h2 class="graf graf--h3">Set up</h2>The Heroku CLI requires Git, the popular version control system. If you don&#x27;t already have Git installed, complete the following before proceeding: <a href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git">Git installation&lt;br/&gt;</a><a href="https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup">First-time Git setup&lt;br/&gt;</a>In this step, you&#x27;ll install the Heroku Command Line Interface (CLI). You use the CLI to manage and scale your applications, provision add-ons, view your application logs, and run your application locally.<a href="https://devcenter.heroku.com/articles/getting-started-with-ruby#set-up">https://devcenter.heroku.com/articles/getting-started-with-ruby#set-up</a><h2 class="graf graf--h3">Prepare the App</h2>To clone the sample application so that you have a local version of the code that you can then deploy to Heroku, execute the following commands in your local command shell or terminal:<code>$ git clone https://github.com/chaskiq/chaskiq.git $ cd chaskiq</code>You now have a functioning git repository that contains a simple application as well as a <code>Gemfile</code> file, which is used by Ruby&#x27;s dependency manager, bundler.<h2 class="graf graf--h3">Deploy the app</h2>In this step you will deploy the app to Heroku. Create an app on Heroku, which prepares Heroku to receive your source code.<code>$ heroku create Creating app... done, ⬢ polar-inlet-4930 http://polar-inlet-4930.herokuapp.com/ | https://git.heroku.com/polar-inlet-4930.git Git remote heroku added</code>When you create an app, a Git remote (called <code>Heroku</code>) is also created and associated with your local git repository. Heroku generates a random name (in this case <code>polar-inlet-4930</code>) for your app, or you can pass a parameter to specify your own app name. Now deploy your code:<code>$ git push heroku master</code><h2 class="graf graf--h3">Configure Environment</h2>Note that you will need setup some environment variables first in order to work properly, (this is not required if you install it through the Heroku button) please refer to the Heroku env vars management https://devcenter.heroku.com/articles/config-vars the required env vars:Select...HOST=https://YOUR_HEROKU_APP_DOMAIN ASSET_HOST=https://YOUR_HEROKU_APP_DOMAIN WS=wss://YOUR_HEROKU_APP_DOMAIN/cable AWS_ACCESS_KEY_ID= AWS_SECRET_ACCESS_KEY= AWS_S3_BUCKET= AWS_S3_REGION= ADMIN_EMAIL=your@email.com ADMIN_PASSWORD=123456 SNS_CONFIGURATION_SET=metricsImportant things are your HOST and WS vars and ADMIN_EMAIL and ADMIN_PASSWORD for initial admin generation and the AWS credentialsNow that you have successfully installed the app, run these commands:heroku run rails db:migrate heroku run rails db:seed<h2 class="graf graf--h3">Create New Admin</h2>The rails admin_generator task will create an admin user for you, you will need to have an ADMIN_EMAIL and ADMIN_PASSWORD on your .env try these credentials:heroku run rails admin_generatorThe application is now deployed, and data migrated. Now visit the app at the URL generated by its app name. As a handy shortcut, you can open the website as follows:<code>$ heroku open</code><h2 class="graf graf--h3">Deploy Worker:</h2>To process the heavy tasks is essential to add a second instance to your dyno formation, so add this command to your dyno formation:<code>bundle exec sidekiq -C config/sidekiq.yml</code>And that&#x27;s it. Happy Chatting!

Heroku is the easiest way to deploy Chaskiq. There are two main modes on which you can deploy the application; the first way is using the Heroku button

, this will not require any local installation and will handle all the heavy lifting for you.

The second way is cloning the repo and installing it through the Heroku client. Let's dig into it.

deploy-on-heroku

https://www.loom.com/share/67f6b45057f347fca4ac4c2b88f6b47a

This tutorial will have you deploying a Ruby app in minutes. Hang on for a few more minutes to learn how it all works so that you can make the most out of Heroku. The tutorial assumes that you have:

Ruby 3.0.3 installed locally - see the installation guides for Ruby and Rails on OS X

 installed locally - run gem install bundler.

The Heroku CLI requires Git, the popular version control system. If you don't already have Git installed, complete the following before proceeding:
Git installation


In this step, you'll install the Heroku Command Line Interface (CLI). You use the CLI to manage and scale your applications, provision add-ons, view your application logs, and run your application locally.

https://devcenter.heroku.com/articles/getting-started-with-ruby#set-up

To clone the sample application so that you have a local version of the code that you can then deploy to Heroku, execute the following commands in your local command shell or terminal:

$ git clone https://github.com/chaskiq/chaskiq.git
$ cd chaskiq

You now have a functioning git repository that contains a simple application as well as a Gemfile file, which is used by Ruby's dependency manager, bundler.

In this step you will deploy the app to Heroku. Create an app on Heroku, which prepares Heroku to receive your source code.

$ heroku create
Creating app... done, ⬢ polar-inlet-4930
http://polar-inlet-4930.herokuapp.com/ | https://git.heroku.com/polar-inlet-4930.git
Git remote heroku added

When you create an app, a Git remote (called Heroku) is also created and associated with your local git repository. Heroku generates a random name (in this case polar-inlet-4930) for your app, or you can pass a parameter to specify your own app name. Now deploy your code:

Note that you will need setup some environment variables first in order to work properly, (this is not required if you install it through the Heroku button) please refer to the Heroku env vars management https://devcenter.heroku.com/articles/config-vars the required env vars:

Select...HOST=https://YOUR_HEROKU_APP_DOMAIN
ASSET_HOST=https://YOUR_HEROKU_APP_DOMAIN
WS=wss://YOUR_HEROKU_APP_DOMAIN/cable


AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_S3_BUCKET=
AWS_S3_REGION=
ADMIN_EMAIL=your@email.com
ADMIN_PASSWORD=123456
SNS_CONFIGURATION_SET=metrics

Important things are your HOST and WS vars and ADMIN_EMAIL and ADMIN_PASSWORD for initial admin generation and the AWS credentials

Now that you have successfully installed the app, run these commands:

heroku run rails db:migrate
heroku run rails db:seed

The rails admin_generator task will create an admin user for you, you will need to have an ADMIN_EMAIL and ADMIN_PASSWORD on your .env try these credentials:

The application is now deployed, and data migrated. Now visit the app at the URL generated by its app name. As a handy shortcut, you can open the website as follows:

To process the heavy tasks is essential to add a second instance to your dyno formation, so add this command to your dyno formation:

bundle exec sidekiq -C config/sidekiq.yml

Heroku is the easiest way to deploy Chaskiq. There are two main modes on which you can deploy the application; the first way is using the Heroku button, this will not require any local installation and will handle all the heavy lifting for you.

Ruby 3.0.3 installed locally - see the installation guides for Ruby and Rails on OS X, Windows, and Linux.

Bundler installed locally - run gem install bundler.

The Heroku CLI requires Git, the popular version control system. If you don't already have Git installed, complete the following before proceeding:
Git installation
First-time Git setup
