Skip to content

Latest commit

 

History

History
89 lines (57 loc) · 2.48 KB

README.md

File metadata and controls

89 lines (57 loc) · 2.48 KB
Raw

fly-shortener

A very simple url shortener based on fly.io, with request logging

Getting Started

Create Service Account

Enable the Sheets API on your Google Cloud Platform project.

Create a service account on Google Cloud and download the JSON credentials. This will contain the service account email as well as the private key needed below.

Create Google Sheets Doc

It should have one sheet with the following columns in order. There can be other columns, these three just need to be next to each other in this order.

  1. From -- The URL path on the shortener
    • ex. /sat-event
  2. To -- The destination URL. This supports using a special YYMMDD sequence that will be replaced with the current date (useful for tracking campaigns)
    • ex. https://alongdomain.com/path/to/url?source=twitter-YYMMDD
  3. Is Regex -- boolean column (TRUE or FALSE) indicating whether the link record does regex matching
    • ex. From: /event/(.*)$ To: https://eventplatform.com/event/$1

Grant read access on the document to the service account email address.

Copy the document ID from the URL.

Copy the range of the short links in A1 notation.

Install fly

See installation docs for platform-specific instructions.

Configure Secrets

cp .env.example .env
vi .env

Launching Redis Application

Fly deprecated their Redis offering and now recommends running your own:

Create Fly Configuration

cp fly.redis.toml.example fly.redis.toml
vi fly.redis.toml

Launch Application

flyctl apps create --name myorg-redis
flyctl volumes create --app myorg-redis myorg_redis_server --region ewr --size 4
flyctl secrets set --app myorg-redis REDIS_PASSWORD="SomethingElseSecretAndComplicated"
flyctl deploy --config fly.redis.toml

Launching Shortlinks Application

Create Fly Configuration

cp fly.shortlinks.toml.example fly.shortlinks.toml
vi fly.shortlinks.toml

Create Fly Application

flyctl apps create --name myorg-shortlinks

Configure Secrets

Set application environment variables via Fly Secrets:

awk '!/^#/ && NF' .env | xargs -p flyctl secrets set --config fly.shortlinks.toml

Launch Application

flyctl deploy --config fly.shortlinks.toml