Deploy

PostOwl is a SvelteKit application inspired by editable.website using SQLite for the database. It’s currently optimised for SvelteKit’s adapter-node to enable deployment to Fly.io.

More deployment options coming soon!#

We’ll be adding instructions for deploying to other hosts soon. If you have success deploying to other platforms, please let us know or submit a PR documenting how you did it.

Sending email in production#

PostOwl uses nodemailer to send email notifications when you send letters to friends.

The application will run without a real SMTP server configured so you can enter dummy data for the SMTP settings when deploying if you don’t need to send emails.

If you’d like to send emails but don’t have an SMTP server to use, we recommend mailgun. Their free tier will cover usage for a personal PostOwl site. You’ll need to own a domain name to get set up with mailgun. Follow their documentation to activate your domain for email sending. Then generate an SMTP password from their admin interface (click ‘Reset password’ under Sending > Domain Settings > SMTP credentials to get a password for a new domain).

Deployment to fly.io#

PostOwl runs for free on fly.io which is one of the reasons we’re recommending their platform for the first release. If you follow the steps here you should have a live site in about 15 minutes.

The PostOwl repository contains the files you need to deploy your PostOwl site to fly.io.

• Create an account with fly.io.
• Add your credit card to Fly. PostOwl runs well on Fly’s free tier but they require an active, valid credit / bank card to prevent abuse. Unless you have a very busy site, hosting will be free.
• Install flyctl and sign in with fly auth login
• Clone the PostOwl code to a directory on your computer: git clone https://github.com/PostOwl/postowl.git- Enter the directory you cloned the repo to: cd postowl
• Run fly apps create --name YOUR_APP_NAME
  • You can choose YOUR_APP_NAME. This will be used as the Fly application name and your app will be available at https://YOUR_APP_NAME.fly.dev
  • The application name has to be unique across Fly - Flyctl will tell you if the name you’ve chosen is already in use. Or you can omit the --name flag and Fly will auto-generate an application name for you.
  • If you own a domain you can set a custom domain later (see below)
• Run the command shown in the block below:
  • Edit all values beginning with YOUR_ (It’s easiest if you paste into a text editor to make the edits)
  • YOUR_APP_NAME must be the same as you set above
  • For the SMTP details, see the section above Sending email in production. You don’t need to use real values to try the app.

fly secrets set -a YOUR_APP_NAME \
  ADMIN_NAME="YOUR_NAME" \
  ADMIN_EMAIL="YOUR_EMAIL" \
  ADMIN_PASSWORD="YOUR_PASSWORD" \
  DB_PATH="/data/YOUR_APP_NAME.sqlite3" \
  ORIGIN="https://YOUR_APP_NAME.fly.dev"
  SMTP_SERVER="YOUR_SMTP_SERVER_ADDRESS" \
  SMTP_PORT="465" \
  SMTP_USERNAME="YOUR_SMTP_USER_NAME" \
  SMTP_PASSWORD="YOUR_SMTP_USER_PASSWORD"

• Run fly deploy -a YOUR_APP_NAME -r YOUR_REGION_ID --volume-initial-size 1
  • For YOUR_REGION_ID, see the list of region codes on the Fly website.

Fly will let you know when the app is deployed. Visit the URL shown in your terminal and sign in with YOUR_PASSWORD as set above.

Have fun with your PostOwl website! 🦉

Use your own domain#

You can serve PostOwl from a domain or subdomain you own.

• Run fly ips list -a YOUR_APP_NAME to get the IPv4 and IPv6 addresses.
• Head over to your DNS provider and add A and AAAA records for YOUR_DOMAIN with the IPv4 and IPv6 values.
• Run fly certs create -a YOUR_APP_NAME YOUR_DOMAIN
• Run fly certs show -a YOUR_APP_NAME YOUR_DOMAIN to watch your certificates being issued
• Update the Fly secret for ORIGIN to be https://YOUR_DOMAIN

More details and considerations for subdomains in the fly docs. If you’re using Cloudflare for DNS make sure to read these docs as the instructions are slightly different.

‘Scale to zero’ on fly.io#

‘Scale to zero’ means that when your site is inactive, the machine will automatically shutdown. This saves costs and electricity. For low traffic personal sites it’s ideal.

In the past, the problem with shutting down is that it would take some time for your site to start up again - remember the Heroku free plan?! Fly.io use firecracker vms which start almost instantly. If your site goes to sleep, you’ll hardly notice it starting up. In our tests it takes about one second for the server to respond to an http request from a cold start! 🔥

The default configuration in PostOwl has auto_stop_machines = true in fly.toml.example. We recommend you keep this setting. We have code that gracefully closes the database connection and shuts down the application server before the machine stops.

Now you can have the benefits of a dynamic web application without the costs of keeping a VPS up all the time. And you’re being kind to the environment! 🌳