Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to main page and related things #1806

Merged
merged 2 commits into from
Aug 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions apps/going-to-production.html.markerb
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ redirect_from:
- /docs/reference/going-to-production/
---

This checklist guides you through setting up a production environment on Fly.io. What makes an app production-ready can vary from one framework to another. You'll need to decide which checklist items work for your app and setup; not all of the items will apply and there may be other considerations not listed here.
Use this checklist to help you set up a production environment on Fly.io.

<div class="important icon">
**Important:** This list is neither exhaustive nor mandatory, and does not guarantee production-readiness for your app. Apps might have unique requirements for production.
**Important:** The checklist is not exhaustive and does not guarantee production-readiness for your app. Apps can have unique requirements for production depending on the framework and type of app. Some items won't be applicable and there may be other considerations not listed here; you'll need to decide which checklist items work for your app.
</div>

## Security
Expand Down
4 changes: 2 additions & 2 deletions apps/index.html.markerb
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ _Store sensitive data, like usernames and passwords, as secrets in your app. Sec

_Get your app ready for production on Fly.io._

- [Going to production with your app](/docs/apps/going-to-production/)
- [Going to production checklist](/docs/apps/going-to-production/)
- [App availability and resiliency](/docs/apps/app-availability/)
- [Tips to fine-tune and (not) benchmark your app on Fly.io](/docs/apps/fine-tune-apps/)
- [Fine-tune your app](/docs/apps/fine-tune-apps/)
- [Guidelines for concurrency settings](/docs/apps/concurrency/)

---
Expand Down
2 changes: 1 addition & 1 deletion blueprints/autostart-internal-apps.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Here's an example `fly.toml` snippet:
**Important:** Set `force_https = false`; Flycast only works over HTTP. HTTPS isn't necessary because all your private network traffic goes through encrypted WireGuard tunnels.
</div>

Learn more about [Fly Launch configuration](/docs/reference/configuration/) and [Fly Proxy autostop/autostart](/docs/launch/autostop-autostart/).
Learn more about [app configuration](/docs/reference/configuration/) and [Fly Proxy autostop/autostart](/docs/launch/autostop-autostart/).

### Make sure your app binds to `0.0.0.0:<port>`

Expand Down
3 changes: 2 additions & 1 deletion getting-started/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Get up and running on Fly.io:

- **[Quickstart](/docs/getting-started/launch/):** Launch your own app now.

- **[Launch a demo app](/docs/hands-on/):** Walk through installing the flyctl command-line tool and creating an account, then launch a simple "hellofly" demo app.
- **[Launch a demo app](/docs/getting-started/launch-demo):** Walk through installing the flyctl command-line tool and creating an account, then launch a simple "hellofly" demo app.

- **[Choose your language or framework](/docs/getting-started/get-started-by-framework/):** Get started on Fly.io with the tech _you_ love.

Expand All @@ -22,6 +22,7 @@ Get up and running on Fly.io:
## Learn more

* [Fly Launch](/docs/apps): You've tried the `fly launch` command. Now learn how to use all the Fly Launch features that help you manage and run your apps.
* [Going to production checklist](/docs/apps/going-to-production/): Considerations for setting up a production environment on Fly.io.
* [Fly.io Blueprints](/docs/blueprints/): A library of patterns and examples that you can apply in your own projects.
* [Databases & Storage](/docs/database-storage-guides/): Options for persistent data storage on Fly.io.
* [Fly Machines](/docs/machines/): Go deeper with our fast-launching VMs, and use them to run your projects and tasks.
Expand Down
2 changes: 1 addition & 1 deletion getting-started/troubleshooting.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Any failures in the `fly doctor` output point to where you can start troubleshoo

### Review your `fly.toml` configuration

Double-check the formatting and configuration options in your `fly.toml` file. Besides [checking port numbers](#warning-the-app-is-listening-on-the-incorrect-address-host-and-port-checking), you should also review any recent changes and make sure you're following the conventions described in [Fly Launch configuration](/docs/reference/configuration/).
Double-check the formatting and configuration options in your `fly.toml` file. Besides [checking port numbers](#warning-the-app-is-listening-on-the-incorrect-address-host-and-port-checking), you should also review any recent changes and make sure you're following the conventions described in the [app configuration](/docs/reference/configuration/) docs.

## Get more information about failures

Expand Down
29 changes: 16 additions & 13 deletions index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ nav: firecracker

<div class="index-page">

## Get started
## Get started

Try our [quickstart or demo app](/docs/getting-started/)

Expand All @@ -20,7 +20,12 @@ Or choose your favorite [language or framework](/docs/getting-started/get-starte

_Fly Launch is app configuration, provisioning, deployment, scaling, and orchestration with our flyctl CLI._

[Work with your apps](/docs/apps/): create, configure, deploy, and scale with Fly Launch, set secrets, and prepare for production
[Create and manage apps](/docs/apps/)

[Going to production checklist](/docs/apps/going-to-production/)

[App config (fly.toml)](/docs/reference/configuration/)


---

Expand All @@ -36,16 +41,10 @@ flyctl is [open source](https://github.com/superfly/flyctl+external)

## Fly Machines

_Machines are fast-launching VMs—and the compute engine of the Fly.io platform._
_Machines are fast-launching VMs—and the compute engine of the Fly.io platform. Get precise, low-level control of Machines with our REST API_

Learn all about [Fly Machines](/docs/machines/)

---

## Machines API

_Get precise, low-level control of Machines with our REST API._

[Machines API docs](/docs/machines/api/)

---
Expand All @@ -62,12 +61,12 @@ _Run GPU workloads on Fly Machines._

_Services from Fly.io and our extension partners to help you run your entire stack near your users._

[Upstash for Redis®](/docs/upstash/redis/)

[Tigris object storage](/docs/tigris/)

[Supabase Postgres (public alpha)](/docs/supabase/)

[Upstash for Redis®](/docs/upstash/redis/)

[LiteFS - Distributed SQLite](/docs/litefs/)

[Fly Kubernetes (private beta)](/docs/kubernetes/)
Expand All @@ -76,9 +75,13 @@ _Services from Fly.io and our extension partners to help you run your entire sta

## Networking

_Private networking, public networking, custom domains and certificates, UDP apps, and routing._
_Networking on Fly.io._

[Private networking](/docs/networking/private-networking)

[Public networking](/docs/networking/services)

[Networking](/docs/networking/) on Fly.io
[Custom domains](/docs/networking/custom-domain/)

---

Expand Down
2 changes: 1 addition & 1 deletion launch/continuous-deployment-with-github-actions.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ This step `uses` the [superfly/flyctl-actions action](https://github.com/marketp

This pulls the API token from GitHub's secrets engine and puts it into the environmental variables passed to the action.

**Step 9** pushes your two new files to the repository: `fly.toml`, the Fly Launch configuration file, and `fly.yml`, the GitHub action file. The push triggers your first automatic deploy. The GitHub action now triggers a redeploy each time you push changes to your repo.
**Step 9** pushes your two new files to the repository: `fly.toml`, the app configuration file, and `fly.yml`, the GitHub action file. The push triggers your first automatic deploy. The GitHub action now triggers a redeploy each time you push changes to your repo.

## Conclusion and further reading

Expand Down
2 changes: 1 addition & 1 deletion launch/volume-storage.html.markerb
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ The volume is mounted in the directory specified by the `destination` field in t
## Related topics

- [Fly Volumes overview](/docs/volumes/overview/)
- [`mounts` section](/docs/reference/configuration/#the-mounts-section) in the `fly.toml` Fly Launch configuration file
- [`mounts` section](/docs/reference/configuration/#the-mounts-section) in the `fly.toml` app configuration file
- [Create and manage volumes](/docs/volumes/volume-manage/)
- [Manage volume snapshots](/docs/volumes/snapshots/)
- [Scale an app with volumes](/docs/apps/scale-count/#scale-an-app-with-volumes)
1 change: 0 additions & 1 deletion partials/_apps_nav.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
{ text: "Move an app between orgs", path: "/docs/apps/move-app-org/" }
]
},
{ text: "App Config (fly.toml)", path: "/docs/reference/configuration/", type: "singleton" },
{
title: "Fly Launch",
path: "/docs/launch/",
Expand Down
2 changes: 1 addition & 1 deletion partials/_firecracker_nav.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

{ text: "Secrets", path: "/docs/apps/secrets/" },

{ text: "Production Apps", path: "/docs/apps/going-to-production/" }
{ text: "Production Checklist", path: "/docs/apps/going-to-production/" }
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions reference/configuration.html.markerb
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Fly Launch configuration (fly.toml)
title: App configuration (fly.toml)
layout: docs
nav: firecracker
---

You can configure an app for deployment on Fly.io using a `fly.toml` file. Configuration of builds, environment variables, internet-exposed services, disk mounts, and release commands go here.
You can configure an app for deployment on Fly.io using a `fly.toml` file. Configuration of builds, environment variables, internet-exposed services, disk mounts, and release commands go here. `fly.toml` configuration applies for apps managed by [Fly Launch commands](/docs/launch/).

## App configuration files

Expand Down
4 changes: 2 additions & 2 deletions reference/fly-launch.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Build information is in the `build` section of `fly.toml`. `fly launch` will f

Reference: [Builders and Fly.io](/docs/reference/builders/)

## Fly Launch configuration
## Fly App configuration

On creation, an app gets a default configuration that will work for most basic web apps.

Expand All @@ -46,7 +46,7 @@ You can make configuration changes by editing an app's `fly.toml` and then runni

The flyctl language-specific scanners make changes to app configuration as part of their work.

Reference: [Fly Launch configuration (fly.toml)](/docs/reference/configuration/)
Reference: [App configuration (fly.toml)](/docs/reference/configuration/)

## Platform resource provisioning

Expand Down
2 changes: 1 addition & 1 deletion reference/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Quick references for often-used resources like flyctl and `fly.toml`. Or dig a l

* **[flyctl](/docs/flyctl/):** The flyctl CLI reference documentation.

* **[App Configuration (fly.toml)](/docs/reference/configuration/):** The settings for configuring your app in the `fly.toml` configuration file. The Fly Launch configuration includes how the app is built, its volume mounts, network services, and more.
* **[App Configuration (fly.toml)](/docs/reference/configuration/):** The settings for configuring your app in the `fly.toml` configuration file. The app configuration includes how the app is built, its volume mounts, network services, and more.

* **[Fly Launch](/docs/reference/fly-launch/):** A deeper dive into how Fly Launch creates and configures new apps.

Expand Down