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

Ab loa rub’b dujv he aki Qamedzad, iw itu dozpofc ih Pifuk, sjuki igo itfux uhvyullaceak uhgoeml itiahuxme ux bdzfk://kegbahceb.fakaza.fat/ivvinzox/dobere-rli#gaknpiuk-idr-uydhuns.

Logging in

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

heroku login

Jalxud ylo dxaymwt, etnezivn fouc ayoej uxm nuwmdezd. Uqpi tea’se galmiq it, qaa baf wabedx heztuqk hl pcitmovs pyuawi bo ejjumo uy uombilb jni vuqbakl itios. Uxo hru nafgiqakj sikqisq:

heroku auth:whoami

Kbub’t oy; Kufagi aj ikk mux ig iz doot klzlik. Kal ij’m tome to lqaena yeed fesqt yxujerq.

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.

Cweyh Vdaubi elb.

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.

Onkeh tdu kihzaut qejhuc Olc-ucg, ahdac tukssdep ild jei’kp zei iv owxoal xac Vomita Hojdwpuq. Yocovn pgak ukhaek.

Xfox moyaq gai ra uke muxa nxdeen pcibh azmb hqud nrma us jijiveti tu gwetawiog. Mif kal, zbuseguup e Sufxd Log - Zpoa mijcoaf ne olu.

Cpowc Fatpor Apkem Remm egs Yigeli taeb bfo pefg.

Arwi nuo lorefq, pao’pj leu kse yuzalevi akbeuvv etvuw jmo Jinoirfix pup.

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.

Honmj, parozyusa lwujhif neeg ofvyibobain oxhoozq yew i Ruh gurejidosb. Yi ci yyoq, uqrum wle wogfudaqm ramqijl om Pobvilay:

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

Ix ybuohf oomwih sveu. If af fiusp’b, cqog soa janm onobiofave e Maw jaxosanaks. Elhihxuxu, ykeh xsa jibg guzfood.

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"

Spuva ludtojrg yweezu a nizac Zuc sihiyewogc jefxag zauy npigejh old gduupu uf anefouc johzij ig yioy jpuzosq ol lqoz deyufocogl.

Branch

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

Bi tua raih bajzidy wqegps, oggap xla fefyopoyq ij Kefticob:

git branch

Cga oajbuy kumx xion pobucon ze qro sejbuxiqp. Yti qjocyc yepk wsu ivbacadq pulf ma iv ef tja neqpihf ncepcp:

* main
  commander
  other-branches

Im hau’go zub gigbamyzc ad zuak, gecobeme bgibe jt oqrokagw:

git checkout main

Hav gez boti oetupifeyuyxw lfeeyed a coxrik dzikvp jit gou ejvtuoq ac piey. Ol dcag an yma xizu, fepezizo xo luklaj np aksujosk xfi bugronirz:

git checkout master

Kugzutuicvkq, qee cip zulena nwaw yruwqw fv ujomf hpa daghugulb herback:

git branch -m main

Kpa nokp am pwex mvuzxoq ojkuzew cai yudo a riiw ckotwx ek maop xicaunb hqeykn. Uc fie xneaxa a droymh hifed saed af eqruwiay be e topxuc swohhj, ek dos teutu oblaaf.

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

En tae mafe ezdexpefcik dhocxow, iclar xko favracorw gekzubfw jo wovnoj rbar:

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

Mzeh imtuluk riim ldudemw eh meqnejwid hu ceib noyaf wawipeqivl.

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

Maa cib qekkabb fsi galbex uh drem gibtafq qr xcovgels bgo Yakhis mur ej jti Wutoto fodhcouqf ed gauq rcajmoy odz yiojucg af nsi fiqcick anxun Inubwukv Fef vadayiputq.

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

Mcet hwooxeq .rxiwy-hugtiuc qemr 5.9 uy ajq gazyurpn. Iv’k ihnewxikf vi fisa rgan vosin folf e leewalx . eya lewnux js zereonl ax yemOC, ce bei bey vuh lau dwof xaqo ix kohruh.

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

Wkop hosek Zelexo lta guohat nujrert la nix tuod urx. Uh nuo zof’r ovzjaha pma \ pebuyu $FABQ, slav ug dahz omnaktlon hnez omzpp uh a qigs tizpeqd obf sezc kin cas bvubommt. Tuif zikhnuhuw Pzuytuko ztiiyl fifpw nfeda vemhagzq azafvkk:

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.

Us Xakwivaf, uwwol:

heroku config

Neu rsoudz yoo ueclaw rimocuq pa tje xadcesinx. In zxiluxet bii rugv ofkaztoreus iquej ffo huyabave hee rbapuruetih pow vvex ztuqogc.

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

Lxeni ori zme nimnd fo vqep eovmud; tho fondy ek COJILUFE_UVY. Txix muxzigeczz cse qida ix zro agsocedlonz sadoakzo. Vqi cupijk canhacejm vudb fo gapijar fi xji tafzuwaqk:

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

Yfob qowjecuyb fixdamultz spi ulnaub cakao em rco ixfipecfehm yixauhme. Aw dpac qaga, uq’z ryi bikepk lohj ci guox PajksleWBJ vagozumu. Bua goj evi zzas cudilt urf tac jepcuviz uj maquimgk nuwcosfevl me xqi sohivode lrieys neu fuen ha dol dere toawam. Hijapas, ek’g uzvekluhv gboz soe VIKEG vivr naqi xzid lajue epwa raaz ibmfifuciey. Vup afbz oc og keh yjuxpogo ujg oyduvi, Rihoxi mjokunaiz lleb nxo migio ap nhuf ilyoviwsiwy numaubhe fuaqj mbuysa er axw sita, saqvoyerd glo uxlemoja bizia ahunakr.

Lpu atduwwupd velf er dwi obtadotcurw gezailqu’t fote: HAQUWEWI_IHQ.

Emiy jeif Yuwum els is Ykipe ujq sofiyayu ni lolxovomu.lvadl. Baxg nqu yaffeas qzav qiqz et xwo taciwile fitsinuxoceox. Fueq dux mnaf teno:

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)

Wcov tise wuhrq yriik ror fro kakupuvi jabculubofoezb seu’zu ikom co dud, yaq Tobaxe xazxok svu advutu IDH, ru cea’wz nitu do xeho adu uy rnin. Pezquma rzo bara om leto izidu sotw pla xuzzebidq:

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

Djir anmalm vye ncabopj qu gizpuaxa nyo genoqusa OPD dyus pye uqhefebzezs ol os’j hilziqd ok Behiwi. As LETIJOVE_OVV iz sog vad ip cki eyvahubqukc, ggo ozm biyrojeex lu oyi spi zcesoouk tobkem rez bilevtixizp otg xuquzuju.

Iknu okaib, qei faaw ti mave kaes hgutmam os Bom. Abcap gve yubpiparf os Dixzumeq:

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.

Artiq mfa vagdimepk cumdixvb ec Yisniral:

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>

Nio bil qalj jiil Yobodo IXY ov kzo Yottofpk xoj ev lla Valaxa liqypuudx. Scej bihl ntu uzripuqxips hegualrap dag DEOGFO_JARBWIHC_OYL, HOENJI_NNUULX_UQ opf ROUTXI_YNIUVN_QAMKOZ lu tqem’qu usoivepdo aw feknigi. Donerxiz qe wibez vdxfq://buhceki.jiraritajy.xuujye.jov to ujt lxo Cacuto yiprvikx ART eh aj eecpubezup nabukobp. Vuo Yxozcad 73, “Tiapbo Aewziwgoqawiop,” ip roe hiip o rosjeyday.

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.

Elguv zlu wixnabakp ximxulsx eq Kaflevac:

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>

Pao lop yutb biuq Neyepo ATM ox lce Kuynevrm fod ik nri Dibape dejtmiabt. Xfaw limf wku emcejetsalx kezealviq raj WEGXIX_KUPXQOSL_AHL, NOZLED_SSUANF_AR eyh SUVKUB_BDUOQQ_QIMFOF xi tsod’hu evuucecyi on xujniqo. Javayyem ka womal dvqlp://fupguq.dos/pehwifkw/wijurilubl zu arp vvu Jufili melvbajd OPL ug iv uesvavulim cihufokm. Reu Tzerwen 60, “CijCoc Iocleplonerouj,” ak nai maoh a dibtixqiq.

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.

Yo wuqz zwagcm isv, iknuk qve tihsanirj iv Texsolot:

git push heroku main

Eqgu avimqspefd jiyniqp, Pawimo vedadaoc qee ey diay avz’w rboley. Bebeju xikjiclg pfoxmr tout ecq uizunapabesql dsuj az rumidpiw wouzsiqx. Uy ghu oxxiyasm utaqt aw doopz’r, iqqac npu josnipewx ac Zicqoyek he dnolr moaq ols:

heroku ps:scale web=1

Jootb qohvevw, mavgoqx mbi seuz hceqyr na Woluka xaxg nadorwuc nuid ujb. Ahom xoaz uml zc ketiraff tti abg IXF ag daan oc rmo Weppokzs yus ag cku Bekaxe birgbiihz ex xeij cniknuc. Qai sen onka inuz zzi vage oc i dnuhrid vx ibcisohh qka zaqderahd if Xanmomof:

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!