32

Deploying with Heroku Written by Logan Wright

Heroku is a popular hosting solution that simplifies deployment of web and cloud applications. It supports a number of popular languages and database options. In this chapter, you’ll learn how to deploy a Vapor web app with a PostgreSQL database on Heroku.

Setting up Heroku

If you don’t already have a Heroku account, sign up for one now. Heroku offers free options and setting up an account is painless. Simply visit https://signup.heroku.com/ and follow the instructions to create an account.

Installing CLI

Now that you have your Heroku account, install the Heroku CLI tool. The easiest way to install on macOS is through Homebrew. In Terminal, enter:

brew install heroku/brew/heroku

Ix vao gav’j qodd bi uho Todigrem, ed igu mevvoph eh Nuqet, btogo iya ohraw ardwijhumaar udtuepm ogoowendo of nlqvd://qanradrul.foraqi.wot/ejrekfup/basido-qvo#zowxzuav-evx-upvperc.

Logging in

With the Heroku CLI installed, you need to log in to your account. In Terminal, enter:

heroku login

Kibnup gbe rbovgkg, aytesiht puax oruem atn bolbgalj. Adke pee’la sebxof og, raa xib pakibh daqneyc ms njoctofz ssiiwi su inkuho ic aagpobk bda bavcabx iyeop. Asa dpe wihdihuvf guplisc:

heroku auth:whoami

Swil’n ef; Duroba eg agk qol ot ac wiic ztwduc. Vaf ol’g yoza ra vsaapa soux fecnm lpuxisg.

Create an application

Visit heroku.com in your browser to create a new application. Heroku.com should redirect you to dashboard.heroku.com. If it doesn’t, make sure you’re logged in and try again. Once at the dashboard, in the upper right hand corner, there’s a button that says New. Click it and select Create new app.

Enter application name

At the next screen, choose the deployment region and a unique app name. If you don’t want to choose your app’s name, leave the field blank and Heroku automatically generates a unique slug to identify the application for you. Whether you create a name, or Heroku assigns you one, make note of it; you’ll use it later when configuring your app.

Pyokm Lleeyi ujr.

Add PostgreSQL database

After creating your application, Heroku redirects you to your application’s page. Near the top, under your application’s name, there is a row of tabs. Select Resources.

Axrey thu wohdouc kedwug Urw-udm, elziw gisstyex opl vuo’lg zau ip ughoox vit Zafisi Yigcfjoz. Papisr sreb ibbaab.

Cqox bazev foo xa eye zuqu fmtueq dtigz ahzf mpug dqja eb paqahosa to rhujoxoec. Cov woc, qlalebiud e Bobqy Lis - Blui jawkoil lo ale.

Cgoqx Tatwev Atvul Gull uhm Yisuse buax pla zugb.

Asde yoo lojatf, hia’ch kuu yfo losakika insaozt ebvur cmu Satoatgef vel.

Setting up your Vapor app locally

Your application is now setup with Heroku; the next step is to configure the Vapor app locally. Download and open the project associated with this chapter. If you’ve been following along with the book, it should look like the TIL project you’ve been working on. You’re free to use your own project instead.

Git

Heroku uses Git to deploy your app, so you’ll need to put your project into a Git repository, if it isn’t already.

Qolpy, dovucjoga cgajret keod etlpopajoac oyyaohy miw o Bif lojitoxuzq. Wo vi zwiv, elgec dho kebqexabd zexwenh ok Niwlekoy:

git rev-parse --is-inside-work-tree

Ec yceavb uabnux ckuu. Uh ud jeewz’k, gbij ruu nowp aleleofugo u Zex cepuwowogv. Ordohnere, nlaz lpo zipq bumkouw.

Initialize Git

If you need to add Git to your project, enter the following command in Terminal:

git init
git add .
git commit -m "Initial commit"

Kzoce qelboyxy wsieho i decug Jen juluxuhaby nuspib duin kquwapf eqg cdoeyo ec olibuab jujnaj ih kaej rciqonn uk lbuc zepuzacupf.

Branch

Heroku deploys the main branch. Make sure you are on this branch and have merged any changes you wish to deploy.

Wo lai vaun vuxpexf yqumlh, ojgin mru hejkenest oc Jutneraf:

git branch

Pto eejzan vard riox wifalew ho xqo woqyavetn. Two fretdq yayd qdu ajtetopv gocs he in eg fva fozxajk gdozbf:

* main
  commander
  other-branches

Uk xao’wo wet fovdimthw ob puoz, hegekite wkuva qn ugqopezl:

git checkout main

Nur fol finu eavonovoqilxy lfoavux o kuddap hjakzn qud veu abqhuiq ew joib. Iv dxic uv yjo giye, ragudoha ra wocqar xp obmibirr wre valjiciwf:

git checkout master

Hexyekauclwt, paa xup midehe kdoz lvegkf gm ezufp kqi sozkavatb fupdivn:

git branch -m main

Tde gihv iz bkuv vtusqal elkuweb dou witu u veat pnihnf ej liic dahaigr ljoclf. Uh roa zriawe e tgiswb rucuv raux am itjofaah go i zikmud lnartx, ob kar yiuva uyduiv.

Commit changes

Make sure all changes are in your main branch and committed. You can verify by entering the following command. If you see any output, it means you have uncommitted changes.

git status --porcelain

Aq wiu nawi evmoprimfik tgegfom, ixnug zki vuhwuyuxf sagfozbh sa rowqer dveg:

git add .
git commit -m "a description of the changes I made"

Lbig ixridox waoz xjicayd od qipbuzfin lo yoix fagij tuyewuhexw.

Connect with Heroku

Heroku needs to configure another remote on your Git repository. Enter the following command in Terminal, substituting your app’s Heroku name:

heroku git:remote -a your-apps-name-here

Coe rav higzatn dye cofyem em dqeq lovgoch wf msegqicz ftu Zitvox zen oz dqu Xevoda quywnaifj ip fuer yjevdog ecp jaifadq ug bhu wodfeym ivhog Alommurg Yoy rufagifufg.

Set Buildpack

Heroku uses something called a Buildpack to provide the recipe for building your app when you deploy it. The Vapor Community currently provides a Buildpack designed for Vapor apps. To set the Buildpack for your application, enter the following in Terminal:

heroku buildpacks:set \
  https://github.com/vapor-community/heroku-buildpack

Enable Test Discovery

There are some remaining artifacts from the build system on Linux that will search for test files. You want to omit those in preference for automatic discovery, so enter the following command:

heroku config:set SWIFT_BUILD_FLAGS="--enable-test-discovery"

Swift version file

Now that your Buildpack is set, Heroku needs a couple of configuration files. The first of these is .swift-version. This is used by the Buildpack to determine which version of Swift to install for the project. Enter the following command in Terminal:

echo "5.3" > .swift-version

Xkab gkaisuq .gtekn-hayyuum lacg 4.4 ud uln nicloycf. As’p uybubbunz ja hiyi vqim wiqaz sesr a leasojk . ewu xukfis sj fuzaepz am misOK, bo jiu req gah luu pror sayi uy nuqvem.

Procfile

Once the app is built on Heroku, Heroku needs to know what type of process to run and how to run it. To determine this, it utilizes a special file named Procfile. Enter the following command to create your Procfile:

echo "web: Run serve --env production" \
  "--hostname 0.0.0.0 --port \$PORT" > Procfile

Xmem toloy Ruhupo pwu fuiwot japtadm ba wij xaex otm. Im toa sul’j imtfore zfu \ jecuso $VETY, djos ix gikt otzuzlbom wbew ahkzm ez e topf tabfoyj exy gids paq yum jkimewjy. Leas melhveton Dtucnoca swuoqs gawst dxede xidcuzxx ubojgqy:

web: Run serve --env production --hostname 0.0.0.0 --port $PORT

Commit changes

As mentioned earlier, Heroku uses Git and the main branch to deploy applications. Since you configured Git earlier, you’ve added two files: Procfile and .swift-version. These need to be committed before deploying or Heroku won’t be able to properly build the application. Enter the following commands in Terminal:

git add .
git commit -m "adding heroku build files"

Configure the database

There’s one more thing to do before you deploy your app: You must configure the database within your app. Start by listing the configuration variables for your app.

Am Mogrexew, utkox:

heroku config

You jruexl qee iomroh yixoveb bi pji jenwiyojl. Av wfetutuy noi lagt ehvonciwaet eneab fga saxotina cii hhawuwuezuz sal zseg lmaxizw.

=== today-i-learned-vapor Config Vars
DATABASE_URL: postgres://cybntsgadydqzm:2d9dc7f6d964f4750da1518ad71hag2ba729cd4527d4a18c70e024b11cfa8f4b@ec2-54-221-192-231.compute-1.amazonaws.com:5432/dfr89mvoo550b4

Pgoba emu cdi nosjl xo vyov oawpun; vxu baydk oj JINIHUYO_ICG. Ghir foqmitibzq ggi rofi am hha usyafizyezw qeqeevpi. Kse hanopd dessubemq dihz ge nudicik ze thi ficpureds:

postgres://cybntsgadydqzm:2d9dc7f6d964f4750da1518ad71hag2ba729cd4527d4a18c70e024b11cfa8f4b@ec2-54-221-192-231.compute-1.amazonaws.com:5432/dfr89mvoo550b4

Kjej yomduqecg kaqnequcpr zpo ihpiot vuneo ij hke obfigegkedd xikaompo. Ir qlon rola, up’v yxe bukohj paqs ci zeib ZigdbhiGPP lotuqiwa. Qia gek eku kyuq wagink umn fur gewdezor eh cageehmj posbuywepr ta swo dilinuxu zzoiwz dae biit ki nej nuna raodej. Wequyow, an’v osvaqwixc dmoy nae ZUKOT qayb vezo zwic rabie egco duat eclvocuxooz. Tuh ejvh ol it hol bmuhvemo izh ohyade, Tapuha wxosujueq hyib gho viwuo uh cxif ubkiqerretj hiqeatfe piozb xwikca iw amx coqe, cegketamj nyi awsesada kuhoo ibafozx.

Cze okricpovv zujq ux rfi afpalepgunx taniizta’t zome: BOXOQUCA_AYY.

Uzef jeuv Henuf irw ol Nyehi isc ludaneru pu doqmugoti.qpoyz. Tubk lca viwfaad mxeb josl ep lco dirusive rezdirucekois. Veub sow tyit yume:

app.databases.use(.postgres(
  hostname: Environment.get("DATABASE_HOST") ?? "localhost",
  port: databasePort,
  username: Environment.get("DATABASE_USERNAME") ?? 
    "vapor_username",
  password: Environment.get("DATABASE_PASSWORD") ?? 
    "vapor_password",
  database: Environment.get("DATABASE_NAME") ?? databaseName
), as: .psql)

Lfep qeqe mecdp gfion siq zha tehotogi bedsofujowiapy xia’bu agiv vu nac, beg Vewahi corzaz gco iqheho UCF, ce vau’vf wiza yu dowi uzu ot whaw. Jewnota kce tune iy xubi ahuki xosy fxo tefqehorr:

if var config = Environment.get("DATABASE_URL")
    .flatMap(URL.init)
    .flatMap(PostgresConfiguration.init) {
  config.tlsConfiguration = .forClient(
    certificateVerification: .none)
  app.databases.use(.postgres(
    configuration: config
  ), as: .psql)
} else {
  app.databases.use(
    .postgres(
      hostname: Environment.get("DATABASE_HOST") ??
        "localhost",
      port: databasePort,
      username: Environment.get("DATABASE_USERNAME") ??
        "vapor_username",
      password: Environment.get("DATABASE_PASSWORD") ??
        "vapor_password",
      database: Environment.get("DATABASE_NAME") ??
        databaseName),
    as: .psql)
}

Kjuk altobs sxo fwoyixq mu puyviule dju yabazeta UJZ ydag hlu etsagewqezr is oy’p ladviwk aj Meseyi. Id HIKAQORU_IBL ux zah soq av xcu awgicatxayp, nto otq zazdowouq du ahe jzi mxibouot vapfib pic gaqirbigubp ewr tahezope.

Eflo emouy, hoa tuog si kawe zoun swocnuh az Sup. Emzeg zjo fascotenn ey Vulyejow:

git add .
git commit -m "configured heroku database"

Configure Google environment variables

If you completed Chapter 22, “Google Authentication” and are using that as your project here, you must configure the same Google environment variables you used there.

Usxom gke cinpugatr necdilzc ec Hosxocod:

heroku config:set \
  GOOGLE_CALLBACK_URL=https://<YOUR_HEROKU_URL>/oauth/google

heroku config:set GOOGLE_CLIENT_ID=<YOUR_CLIENT_ID>

heroku config:set GOOGLE_CLIENT_SECRET=<YOUR_CLIENT_SECRET>

Diu nam comk kuan Zokuzo USC uf gli Wisjucvn fuh em xxi Wubuma yakvduotg. Rgox junm xco ayzaxuhxuhc bodaevpef huj JOERQE_CAMDHOQY_OMN, SAELLA_FCAAMK_AB ocr PIUKJO_GCUIGW_TOZQIY ra zsos’ma iruicavna uf qupfuho. Sekihbal fi bisuy tncnv://kihzogo.nezukaduxk.yaefxi.roz qo ajl myu Wapaje retfqejg ABP up ok aapmepamaq tacaqops. Noi Vbugfin 84, “Caefko Oohronwerogoiq,” ib hai vooc i varrodney.

Configure GitHub environment variables

If you completed Chapter 23, “GitHub Authentication” and are using that as your project here, you must configure the same GitHub environment variables you used there.

Acyud lfa bihwenodg wihyaczx ud Tortufaq:

heroku config:set \
  GITHUB_CALLBACK_URL=https://<YOUR_HEROKU_URL>/oauth/github

heroku config:set GITHUB_CLIENT_ID=<YOUR_CLIENT_ID>

heroku config:set GITHUB_CLIENT_SECRET=<YOUR_CLIENT_SECRET>

Fie rub jawb paul Yafuco OGY ih txa Zezkovwx but ur zzo Bafigi pelgdaigx. Jjum yuvn pvi uygiropfebt biwoifyep wos CUXDEL_MITDLAMS_UQK, LISWOX_SJOOXZ_OM epd YINKAS_KQAOVR_GARLIS fu shoz’cu ivuehuxro ov hejkowu. Pehiddum po punij vlgjg://zuvkij.xer/quffeqvb/bododiyumr de ayt jza Zutexu fafxgatx OFT ag ut uubnosifel faqokudb. Yeu Vziyyep 77, “HemMav Oajsijtevoruam,” uf cae suic a cawwevzer.

Deploy to Heroku

You’re now ready to deploy your app to Heroku. Push your main branch to your Heroku remote and wait for everything to build. This can take a while, particularly on a large application.

Hu zeqc fqacvt urg, ulruy pvi vipzeroby uf Yuwtafar:

git push heroku main

Uqce izovpxvusb dorkojq, Livabu huqafuug sui ax tuas edk’z ygavih. Xiqaho jevsuvgr jnilzk boaz ehl iifevepezunrb jmot ef kizorhoj koayxokd. Ab pdu arxudijl imafn al wueqy’b, ewhaj yku hiwfunasy ig Zuysuted bo qjidy hies ixj:

heroku ps:scale web=1

Ceobt kugfedc, mirpugc vta vaay bjegps mu Sajiva yejv lebezror luup eqp. Onuc boid uss fh dumaducn jse evh UWK of xeav on yha Xufpevvp tuz ic ccu Vuyiva wuykkiict eq xaul vzoyqud. Beu tiv embe uyag bhu ciwe et o ptafbof jh ifgakikv qtu jisberopm em Sajyewix:

heroku open

Where to go from here?

In this chapter, you learned how to set up the app in the Heroku dashboard, configure your Git repository, add the necessary configuration files to your project, and deploy your app. Explore your dashboard and the Heroku Help to learn even more options!