Deploy docs

Author: dahlia

.vscode/settings.json

@@ -54,6 +54,7 @@
     "followees",
     "halfyear",
     "hongminhee",
+    "HSTS",
     "inlines",
     "linkify",
     "logtape",

docs/.vitepress/config.mts

@@ -40,6 +40,16 @@ const concepts = {
   ],
 };
 
+const deploy = {
+  text: "Deploy",
+  items: [
+    { text: "Store and message queue", link: "/deploy/store-mq.md" },
+    { text: "Deno Deploy", link: "/deploy/deno-deploy.md" },
+    { text: "Docker", link: "/deploy/docker.md" },
+    { text: "Self-hosting", link: "/deploy/self-hosting.md" },
+  ],
+};
+
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
   title: "BotKit by Fedify",
@@ -52,6 +62,7 @@ export default defineConfig({
       { text: "About", link: "/intro.md" },
       { text: "Start", link: "/start.md" },
       concepts,
+      deploy,
       { text: "Recipes", link: "/recipes.md" },
       { text: "Examples", link: "/examples.md" },
     ],
@@ -60,6 +71,7 @@ export default defineConfig({
       { text: "What is BotKit?", link: "/intro.md" },
       { text: "Getting started", link: "/start.md" },
       concepts,
+      deploy,
       { text: "Recipes", link: "/recipes.md" },
       { text: "Examples", link: "/examples.md" },
       { text: "Changelog", link: "/changelog.md" },

docs/deploy/deno-deploy.md

@@ -0,0 +1,108 @@
+---
+description: >-
+  Learn how to deploy your BotKit bot to Deno Deploy, a serverless hosting
+  platform for Deno applications.
+---
+
+Deno Deploy
+===========
+
+[Deno Deploy] is a serverless hosting platform for Deno applications.  It allows
+you to deploy your bot without managing servers or infrastructure.  This guide
+shows you how to deploy your BotKit bot to Deno Deploy.
+
+[Deno Deploy]: https://deno.com/deploy
+
+
+Prerequisites
+-------------
+
+ 1. [Create a Deno Deploy account][1]
+
+ 2. [Install the Deno CLI][2] if you haven't already
+
+ 3. [Install `deployctl`][3]:
+
+    ~~~~ sh
+    deno install -gArf jsr:@deno/deployctl
+    ~~~~
+
+ 4. Install the [Fedify] package to your bot project:
+
+    ~~~~ sh
+    deno add jsr:@fedify/fedify
+    ~~~~
+
+ 5. Configure your bot to use Deno KV for storage and message queue:
+
+    ~~~~ typescript
+    import { createBot } from "@fedify/botkit";
+    import { DenoKvMessageQueue, DenoKvStore } from "@fedify/fedify/x/deno";
+
+    const kv = await Deno.openKv();
+
+    const bot = createBot<void>({
+      username: "mybot",
+      kv: new DenoKvStore(kv),
+      queue: new DenoKvMessageQueue(kv),
+      // ... other configuration
+    });
+    ~~~~
+
+[1]: https://dash.deno.com/login
+[2]: https://docs.deno.com/runtime/getting_started/installation/
+[3]: https://docs.deno.com/deploy/manual/deployctl/#install-deployctl
+[Fedify]: https://fedify.dev/
+
+
+Deploying your bot
+------------------
+
+ 1. Navigate to your project directory
+
+ 2. Deploy your bot:
+
+    ~~~~ sh
+    deployctl deploy
+    ~~~~
+
+    On the first deployment, `deployctl` will:
+
+     -  Guess the project name from your Git repo or directory name
+     -  Create the project automatically if it doesn't exist
+     -  Look for common entrypoint files like *main.ts* or *src/main.ts*
+
+    You can also specify these explicitly:
+
+    ~~~~ sh
+    deployctl deploy --project=mybot --entrypoint=bot.ts
+    ~~~~
+
+ 3. Set up your custom domain in the Deno Deploy dashboard (optional)
+
+
+Environment variables
+---------------------
+
+You can set environment variables in multiple ways:
+
+ -  During deployment using the `--env` flag:
+
+    ~~~~ sh
+    deployctl deploy --env=SERVER_NAME=mybot.deno.dev
+    ~~~~
+
+ -  Using an environment file:
+
+    ~~~~ sh
+    deployctl deploy --env-file=.env
+    ~~~~
+
+ -  Or configure them in the Deno Deploy dashboard for project-wide settings
+
+Common variables include:
+
+ -  `SERVER_NAME`: Your bot's domain (e.g., `mybot.deno.dev`)
+ -  Other bot-specific configuration variables
+
+<!-- cSpell: ignore deployctl mybot -->

docs/deploy/docker.md

@@ -0,0 +1,80 @@
+---
+description: >-
+  Learn how to deploy your BotKit bot using Docker containers on platforms like
+  Fly.io and Railway.
+---
+
+Docker
+======
+
+Docker containers provide a consistent deployment environment and can be hosted
+on various platforms like [Fly.io], [Railway], or any container hosting service.
+
+[Fly.io]: https://fly.io/
+[Railway]: https://railway.com/
+
+
+Creating a *Dockerfile*
+-----------------------
+
+Create a *Dockerfile* in your project root:
+
+~~~~ dockerfile [Dockerfile]
+FROM denoland/deno:2.1.9
+
+WORKDIR /app
+
+# Cache dependencies
+COPY deno.json deno.json
+COPY deno.lock deno.lock
+RUN deno install
+
+# Copy source code
+COPY . .
+
+# The bot needs network access and environment variables
+ENV SERVER_NAME=your-domain.com
+
+# Run the bot
+CMD ["deno", "run", "-A", "bot.ts"]
+~~~~
+
+
+Deploying to [Fly.io]
+---------------------
+
+ 1. Install the [Fly.io CLI]
+
+ 2. Initialize your Fly.io app:
+
+    ~~~~ bash
+    fly launch
+    ~~~~
+
+ 3. Configure environment variables:
+
+    ~~~~ bash
+    fly secrets set SERVER_NAME=your-domain.com
+    ~~~~
+
+ 4. Deploy your app:
+
+    ~~~~ bash
+    fly deploy
+    ~~~~
+
+[Fly.io CLI]: https://fly.io/docs/flyctl/
+
+
+Deploying to [Railway]
+----------------------
+
+ 1. Create a new project on [Railway]
+
+ 2. Connect your GitHub repository
+
+ 3. Configure environment variables in the Railway dashboard
+
+ 4. Railway will automatically build and deploy your container
+
+<!-- cSpell: ignore denoland -->