Production Configuration

<p class="graf graf--p">There are many ways to deploy Chaskiq on the cloud. This article is about the deployment of Chaskiq&#x27;s Docker image on DigitalOcean. Note that this procedure will be similar on other cloud providers, K8s context and so.</p><h2 class="graf graf--h3">Requirements:</h2><p class="graf graf--p">Chaskiq has two databases that have to be connected, that&#x27;s Redis and Postgres. So, the easiest way, if you don&#x27;t have databases already, is to create that on the managed databases section on DigitalOcean. Please check the details before proceeding: https://www.digitalocean.com/products/managed-databases/ when you have the databases you will need the string connection information for both: the format is like this:</p><p class="graf graf--p"></p><p>postgresql://user:pass@db-postgresql-nyc1-xxxxx.db.ondigitalocean.com:25060/yourdatabase?sslmode=require</p><h2 class="graf graf--h3">Enter DO Apps</h2><p class="graf graf--p">Go to <a href="https://cloud.digitalocean.com/apps/new">https://cloud.digitalocean.com/apps/new</a></p><p class="graf graf--p">Choose the DockerHub option and for the Repository add <b>chaskiq/chaskiq</b>, for the tag you can use <b>latest </b>or and specific tag that can be found at <a href="https://hub.docker.com/r/chaskiq/chaskiq/tags">here</a>.</p><p class="graf graf--p"></p><figure class="graf graf--figure"><div><div class="aspectRatioPlaceholder is-locked"><div class="aspect-ratio-fill" style="padding-bottom:75.22464698331194%"></div><img src="/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBaUlKIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--865a385467f0bae0a284dcce31db6a6a6b9c387e/image.png" class="graf-image" contenteditable="false"/></div></div><figcaption class="imageCaption"><span><span data-text="true">example docker-hub app</span></span></figcaption></figure><p class="graf graf--p">Then you will be asked for some configurations</p><p class="graf graf--p"></p><p class="graf graf--p"><b>Run Command:</b></p><p class="graf graf--p">The run command you have to configure is:</p><p>bundle exec rails s -b 0.0.0.0 -p 3000</p><p class="graf graf--p"><b>HTTP Port:</b></p><p class="graf graf--p">The HTTP port has to be the same as the port in the build command, so put port <b>3000.</b></p><p class="graf graf--p"><b><br/>Environment Variables:</b></p><p class="graf graf--p">Make sure you put the proper environment variables on the prompt. But don&#x27;t worry you could also edit this later. </p><p class="graf graf--p">Check the Chaskiq <a href="https://dev.chaskiq.io/en/articles/enviroment-variables-configuration">environment variables article</a>.</p><p class="graf graf--p"></p><p class="graf graf--p">When you are done, hit next and the app will be built in a minute. </p><p class="graf graf--p"></p><h2 class="graf graf--h3">Sidekiq Worker</h2><p class="graf graf--p">Chaskiq does some background tasks in order to not block the web process with heavy tasks like emails, file uploading, and messaging, The process that handles all the work is a Sidekiq server that has to be installed too, This is different from web apps because they don&#x27;t receive internet traffic, they just receive instructions internally to perform tasks. <br/>Once you got the Web app working you will need to add Sidekiq as an App Worker component. So, in the DO app panel go to components and add a worker.</p><p class="graf graf--p"></p><figure class="graf graf--figure"><div><div class="aspectRatioPlaceholder is-locked"><div class="aspect-ratio-fill" style="padding-bottom:55.225148683092605%"></div><img src="/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBcDREIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--482fba5cfe0439d00e34804e3dd2de8eb3d7fc2c/image.png" class="graf-image" contenteditable="false"/></div></div><figcaption class="imageCaption"><span><span data-text="true">worker add</span></span></figcaption></figure><p class="graf graf--p">The process is simple, just add the Worker components and choose the same repo for the worker. Also, you will have to put the same ENV vars as your web process. The only difference is that you have to set a different start command, the start command is:<br/></p><p>bundle exec sidekiq -C config/sidekiq.yml</p><p></p><h2 class="graf graf--h3">Domains:</h2><p class="graf graf--p">The Digital ocean will give you a standard domain, that will end with the .ondigitalocean.app, that&#x27;s good enough to get started, precisely because it has SSL support. But you can also set your own domain to the instance, just make sure to change the HOST and WS env vars.</p><p class="graf graf--p"></p><p></p><h1 class="graf graf--h2">Full tutorial</h1><h2 class="graf graf--h3">Part 1</h2><figure class="graf--figure graf--iframe graf--first"><div class="iframeContainer">&lt;iframe src=&quot;https://www.loom.com/embed/cf73325d8e45489e8798c90949eb6719&quot; frameborder=&quot;0&quot; width=&quot;1176&quot; height=&quot;882&quot; webkitallowfullscreen mozallowfullscreen allowfullscreen&gt;&lt;/iframe&gt;</div><figcaption class="imageCaption"><div class="public-DraftStyleDefault-block public-DraftStyleDefault-ltr"><span><span>https://www.loom.com/share/cf73325d8e45489e8798c90949eb6719</span></span></div></figcaption></figure><h2 class="graf graf--h3">Part 2 - Environment Variables</h2><figure class="graf--figure graf--iframe graf--first"><div class="iframeContainer">&lt;iframe src=&quot;https://www.loom.com/embed/07ae32f404214e8bbf81ac600238764a&quot; frameborder=&quot;0&quot; width=&quot;1176&quot; height=&quot;882&quot; webkitallowfullscreen mozallowfullscreen allowfullscreen&gt;&lt;/iframe&gt;</div><figcaption class="imageCaption"><div class="public-DraftStyleDefault-block public-DraftStyleDefault-ltr"><span><span>https://www.loom.com/share/07ae32f404214e8bbf81ac600238764a?sharedAppSource=personal_library</span></span></div></figcaption></figure><p class="graf graf--p">Environment Variable template can be found here: https://gist.github.com/michelson/c25495159eabbf6fc473da5513bc9e83</p><p class="graf graf--p"></p><p class="graf graf--p"></p><h2 class="graf graf--h3">Part 3 </h2><figure class="graf--figure graf--iframe graf--first"><div class="iframeContainer">&lt;iframe src=&quot;https://www.loom.com/embed/9628328e585249bdb4d00682d2ad7a9b&quot; frameborder=&quot;0&quot; width=&quot;1176&quot; height=&quot;882&quot; webkitallowfullscreen mozallowfullscreen allowfullscreen&gt;&lt;/iframe&gt;</div><figcaption class="imageCaption"><div class="public-DraftStyleDefault-block public-DraftStyleDefault-ltr"><span><span>https://www.loom.com/share/9628328e585249bdb4d00682d2ad7a9b?sharedAppSource=personal_library</span></span></div></figcaption></figure><h2 class="graf graf--h3">Part 4 - Database Migrations and seedding</h2><figure class="graf--figure graf--iframe graf--first"><div class="iframeContainer">&lt;iframe src=&quot;https://www.loom.com/embed/b25959db012a4953880f30fca0e9be62&quot; frameborder=&quot;0&quot; width=&quot;1176&quot; height=&quot;882&quot; webkitallowfullscreen mozallowfullscreen allowfullscreen&gt;&lt;/iframe&gt;</div><figcaption class="imageCaption"><div class="public-DraftStyleDefault-block public-DraftStyleDefault-ltr"><span><span>https://www.loom.com/share/b25959db012a4953880f30fca0e9be62?sharedAppSource=personal_library</span></span></div></figcaption></figure><p class="graf graf--p"></p><p class="graf graf--p"></p><p class="graf graf--p"></p><p class="graf graf--p"></p><p class="graf graf--p"></p><p class="graf graf--p"></p>

There are many ways to deploy Chaskiq on the cloud. This article is about the deployment of Chaskiq's Docker image on DigitalOcean. Note that this procedure will be similar on other cloud providers, K8s context and so.

Chaskiq has two databases that have to be connected, that's Redis and Postgres. So, the easiest way, if you don't have databases already, is to create that on the managed databases section on DigitalOcean. Please check the details before proceeding: https://www.digitalocean.com/products/managed-databases/ when you have the databases you will need the string connection information for both: the format is like this:

postgresql://user:pass@db-postgresql-nyc1-xxxxx.db.ondigitalocean.com:25060/yourdatabase?sslmode=require

Go to https://cloud.digitalocean.com/apps/new

Choose the DockerHub option and for the Repository add chaskiq/chaskiq, for the tag you can use latest or and specific tag that can be found at here

Then you will be asked for some configurations

The run command you have to configure is:

The HTTP port has to be the same as the port in the build command, so put port 3000.

Make sure you put the proper environment variables on the prompt. But don't worry you could also edit this later. 

Check the Chaskiq environment variables article

When you are done, hit next and the app will be built in a minute. 

Chaskiq does some background tasks in order to not block the web process with heavy tasks like emails, file uploading, and messaging, The process that handles all the work is a Sidekiq server that has to be installed too, This is different from web apps because they don't receive internet traffic, they just receive instructions internally to perform tasks. 
Once you got the Web app working you will need to add Sidekiq as an App Worker component. So, in the DO app panel go to components and add a worker.

The process is simple, just add the Worker components and choose the same repo for the worker. Also, you will have to put the same ENV vars as your web process. The only difference is that you have to set a different start command, the start command is:


bundle exec sidekiq -C config/sidekiq.yml

The Digital ocean will give you a standard domain, that will end with the .ondigitalocean.app, that's good enough to get started, precisely because it has SSL support. But you can also set your own domain to the instance, just make sure to change the HOST and WS env vars.

DigitalOcean App Platform - part-1 - install app

https://www.loom.com/share/cf73325d8e45489e8798c90949eb6719

chaskiq-chaskiq - DigitalOcean App Platform - part 2 - env variables

https://www.loom.com/share/07ae32f404214e8bbf81ac600238764a?sharedAppSource=personal_library

Environment Variable template can be found here: https://gist.github.com/michelson/c25495159eabbf6fc473da5513bc9e83

chaskiq-chaskiq - DigitalOcean App Platform - Part 3 - db creation

https://www.loom.com/share/9628328e585249bdb4d00682d2ad7a9b?sharedAppSource=personal_library

Part 4 - Database Migrations and seedding

chaskiq-chaskiq - DigitalOcean App Platform - Part 4 Final setup

https://www.loom.com/share/b25959db012a4953880f30fca0e9be62?sharedAppSource=personal_library

Choose the DockerHub option and for the Repository add chaskiq/chaskiq, for the tag you can use latest or and specific tag that can be found at here.