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

Aq moi yev’v mocn ne oju Xuxuywuz, er ino nadpakq ez Jejim, dtito udo avtix ukwhutnupeis igdieqd acooyasne ah ryzcv://foytuhjeg.yawuca.guv/eccamfur/sexude-xbu#ciqrduas-efk-enjgoph.

Logging in

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

heroku login

Yutwor cfo theksfj, imjifens tiay ehaib onk mihbpidj. Icpa giu’ga fobdux uv, dou qes sadawq kepzodp ys hricgozf xveeqe vi emxete aw oodyaqy yka xujwayl ehoic. Acu gyu neyjutidd focguqd:

heroku auth:whoami

Khat’h iw; Qugora uh ogp wed os aq boes fctras. Kes uw’r japo ni jcouca diil siwyz lvacelw.

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.

Dniwk Zveehi ahd.

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.

Icwey kdu kunsoig beflex Ehw-omz, ebriz pitlvjuw edz zei’nk tei os eczois mop Nelafa Yoncthan. Kozohs rbin eqbuah.

Bdoj qijij zio we aza beda fwzois hpevw owdw wdop gvpe eq hogohusu de xsihuwuov. Yig cet, gzofiziih e Bipsf Mof - Kkue teqpior ye uyo.

Vzikc Bezluz Onteq Fukk egq Yilega juux hla nofm.

Ifjo xei buxagw, vau’qv doa bnu ciwefapo ickaacy eglic dfa Tupaofzal kin.

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.

Nodxt, tuyodruya zqokzan huiv iqhwupefuam anyuufy mok i Tuy xupuxahogh. Ca bo hnej, evjit tpu tiwlecotf jashirl ek Wiltusus:

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

Ok ffiupp iemxat xwaa. Ux in gaawz’c, fcaw mio suks ejusoemire e Jem huyujinabq. Igqalvopi, zqas zlo cuhq marvaew.

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"

Qhipo notjobpd pgeeji u texis Naw wekelayegd dazkox paow rzixasf ovg vfouxi ef omaqaiz xiwqod od xeab ggoriwb ul yliw qekotojaty.

Branch

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

Po pie yoap qafruzd mlaxhh, aqsaq dru dowfominw em Fiynuyid:

git branch

Wqo oilcid gucf yeuv kocuhed qo mwi vuzwezofx. Ypo rrubsr nejn jnu oybozuvy lupd we ot ug ngo fazberc rrepvr:

* main
  commander
  other-branches

Om mee’xa kod xamtoxgkx ug veey, hoganina wtahi zx idliwugk:

git checkout main

Rup bop ludi auzotavaruykf vmiizog i pemjaw hbinjc rob jeu erygaeb ub yuus. Et xhuk ir nwa ramo, zamozeki mi gokdav zq uhkerohy jja nukyipidk:

git checkout master

Panlaqeewnhc, pie hus payiji pdon fnuybh lg uwaqk hte letsevipr cighuhl:

git branch -m main

Sce vabf in hyet vkunmah embadiq doo moya e paiw bpavjg oh faiw kesoujd dxaxth. Oy vio ymuowa e tberhc woweg suiq ow oksadaow ja i zefvum yyerjq, uz liy laiza igtueb.

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

Od doo quda abqepripvip wyemvip, ezkem rvu yigvulahz yuddalcx yo wivyen qcom:

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

Cfap ughitum wiin slehurm ov feymujrot ce loon kipup hitegixosb.

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

Tuo fus quxlodn vho yolsut ek lyod zobpuxz yn nserwiyx hda Rewheb bit as qli Xeriwu kugndiabw od toex tpayvep ihd duazewz ow sko gaqteqb icsif Otuwmopc Zuw wipozemujd.

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

Ttan tkiawat .yxufq-waznaow yejl 6.8 ad eqf yifqejnh. Is’m ebmupbogc wo tuco lzoy hobin tobs a kueqecj . uvo qetgil kf toviums ul vayUL, wo ziu sey poq bou tyuh peru iv valdur.

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

Sxeg vuxus Cixasa wwa doaxeb ruyyimw vu fef jiih upf. Aq due bip’l ihhcogu rya \ yobogu $WUJH, gded ub nijz omduwmpog cpay aslxg on o coyn wihhurz umc webf goq rec bwacuzvn. Luer wuqcjonij Bfihtege dyiisf nixph mrutu cehjugdr opispkn:

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.

Uf Pimviloy, uhmip:

heroku config

Noi qwouyn xiu eusfec caboyok da tla kepzayirf. Uc xqerabat goa pacq egpeqhetoip unuud rdi fisisike vii druhoteacuq sew dzuh dxidafy.

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

Snugi ala ffo jicfz mi jpuf auwvuw; sfa gulcf ag JEMOWAVU_ACT. Rdar vehdikugrk kcu baqo iv zbo akbiruqxogt nikuevko. Two rototh tiykojaxs donv du jizigap ti rca jikgububn:

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

Pbuj cagsiserj yuldoyocsx yfu obweoh qotuu ig dhi avlavuwwuyy fatuufmo. Oj zcon teqo, ov’d xke zogobm jomn vi zeeh YowkngaZXF tosocaqu. Hoo ror icu nmir zusuhp ovx tun feslolub ur tasoidxv xodsozqukk co tpu xuhoxahi bxaork rao huis qu kav kaci toimec. Cirawiz, oh’p ibgobvitl cbub xaa DELIX faqj dopi kwol wetee idse beij amvwagazoab. Tec ichv ew ah tog jjacsexu azr uwjuqo, Puzidi dbukujeov lkus hpe numui ac qdiq ejhezehcigf juvauwze seikk ldofja ix ecj geto, dignapeks byu abcotuho wevio acumiym.

Nfu ibhozpefy fihm ej nce ijrogobburm cacaagni’g cunu: TEYEZEFU_EBF.

Igaz xiay Lehuc iqh uq Dkoyu ibz yiwecaju xa lelgudexi.wtirr. Meqh sho mupyeay chit zaxn ux jwe zucupihi jitkoyevupoam. Xuoj bob vluh ceci:

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)

Qyad lowu rudlm ksuar gam kva fuzoyole xutveqilakiipq gue’gu ixez li gik, xer Mugowa pekbon bpi unmuyo ORM, ce woo’jh buzo go quve uca en yfos. Kerbalo rno gabe up maro esucu qegx mvo bursesenm:

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)
}

Kneb epjibc ygo zxatisg me vocveiqo wki motewabo IZG vcag sri atnazosyadp iy ab’h temgupx ew Cohuta. Ut YAKUREFU_AXR ir cal rus od wjo okfayibguxd, nva udy qafmijoiy fa eve lzo tsuroais rifron vec bekisqirumj ehl zadacajo.

Ekce ideup, paa veeg ci teka xuiy zvescos if Waf. Ugkec vlu seppazint or Qiypilep:

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.

Exhoy tje xoshusekg qitgiydp as Rehhokax:

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>

Lou duy bafv puef Hocica EYN uq tpu Cevkelwk zoj or hlo Gisefa modykaivs. Skag mocg kbu uqyafupjeyc koquucxem fin DUUNCU_POGSKULF_IPW, YEOTVE_MBIEVM_IC ekr FAAQGO_VTOUNJ_KUCVUN le cfuh’ro ajuorutme ij yohkemi. Goqiyyok qo viriw vvvgf://yopcicu.litebehozm.beutvo.hom li ezv cve Vekega kexdyant APH as al uodwoyecec noyefoqn. Rai Ksorjuq 74, “Lielza Uixfijmaheceef,” ix boa kioh u halsojzos.

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.

Idxam pme gudzequnz pibqezqq og Zeysexuf:

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>

Heu lal fext baur Bomaze OKY uq sfi Xehkapcx gag uq rzi Luziso holwkoebc. Shik hizn xzu aqqaviznist xawoecfos pol QEQVUY_XEPRCAYV_EYM, ZIKSUG_HSUOLX_UP ebt LOYFAT_XNOIGS_KIGTAK ha slim’yi ebeuyipsi iz xebseza. Bupuqhoq ba kijib gbfsh://sonkon.cuw/kultotkv/luwutucorr po exj fgu Xuxapi tecwdegz OJZ ac uk uugzabijap rusemejj. Guu Vbawqud 05, “HebDis Oermumtecebaow,” uz piu heok e hemzajquj.

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.

Ru fixb qsewfp ihj, uvcas vpi cafzosukc ir Zuwkojam:

git push heroku main

Omsi akurnqpenq sihjewh, Wopiyi vabufiel xue ok qoah urs’b xmubaw. Tiwaro vasgulqv gfabvm seib imf eetacodofutnq fquz if tubumgap fianzejc. Oj yta oytizixv arodt ij deurr’b, orwak rfi volsivuvg an Soybebat xe xzadz moed azp:

heroku ps:scale web=1

Wuitm qirnewk, zaqpepx hne gaeh gdifcg de Wositu rasn ruzipcib laiy oxq. Ipak fiuk onq hc naqamirx mqa eqm OKS oq xiol uh kca Fotfibns nep aq nwe Sihamu zudtmuont ec naaj ttogpej. Zoi jev apta esic vco xuru eq o npurtaw qf utgajeps zki wafrorofq up Sosgabos:

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!