add fly.io

bpmct · bpmct · commit 68b1b2b9569b · 2023-09-26T20:37:52.000Z
diff --git a/examples/templates/fly-docker-image/README.md b/examples/templates/fly-docker-image/README.md
@@ -7,16 +7,18 @@ verified: true
 tags: [fly, container]
 ---
 
-# Coder Fly.io Template
+# Remote Development on Fly.io Machines
 
-This template provisions a [code-server](https://github.com/coder/code-server) instance on [fly.io](https://fly.io) using the [codercom/code-server](https://hub.docker.com/r/codercom/code-server) image.
+Provision Fly.io Machines as [Coder workspaces](https://coder.com/docs/coder-v2/latest) with this example template.
+
+<!-- TODO: Add screenshot -->
 
 ## Prerequisites
 
 - [flyctl](https://fly.io/docs/getting-started/installing-flyctl/) installed.
 - [Coder](https://coder.com/) already setup and running with coder-cli installed locally.
 
-## Getting started
+### Authentication
 
 1. Run `coder templates init` and select this template. Follow the instructions that appear.
 2. cd into the directory that was created. (e.g. `cd fly-docker-image`)
@@ -34,8 +36,20 @@ coder templates create fly-docker-image \
 > flyctl secrets set FLY_API_TOKEN=$(flyctl auth token) --app <your-coder-app-name>
 > ```
 
-> Read our blog [post](coder.com/blog/deploying-coder-on-fly-io) to learn more about how to deploy Coder on fly.io.
-
 4. Navigate to the Coder dashboard and create a new workspace using the template.
 
-This is all. You should now have a code-server instance running on fly.io.
+## Architecture
+
+This template provisions the following resources:
+
+- Fly.io Machine (ephemeral, deleted on stop)
+- Fly.io Volume (persistent, mounted to `/home/coder`)
+
+This means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the VM image, or use a [startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/script).
+
+> **Note**
+> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
+
+---
+
+Read our blog [post](coder.com/blog/deploying-coder-on-fly-io) to learn more about how to deploy Coder on fly.io.
