├── .buildkite └── pipeline.yml ├── .github ├── ISSUE_TEMPLATE │ ├── improve-docs-content.md │ └── improve-the-fly-io-docs-site.md ├── pull_request_template.md └── workflows │ └── vale-docs-linter.yml ├── .gitignore ├── .vale.ini ├── LICENSE ├── README.md ├── about ├── billing.html.markerb ├── brand.html.markerb ├── extensions.html.markerb ├── healthcare.html.markerb ├── index.html.markerb ├── merch.html.markerb ├── open-source.html.markerb ├── pricing.html.markerb └── support.html.md ├── app-guides ├── 6pndemochat.html.erb ├── edgedb.html.md ├── fauna.html.md ├── git-gogs-server.html.erb ├── global-nginx-proxy.html.markerb ├── graphql-edge-caching-apollo.html.erb ├── graphql-on-fly-with-hasura.html.markerb ├── grpc-and-grpc-web-services.html.erb ├── kong-api-gateway.html.erb ├── livebook.html.markerb ├── minio.html.markerb ├── mqtt.html.erb ├── multiple-processes.html.md ├── mysql-on-fly.html.markerb ├── nats-cluster.html.erb ├── node-red.html.erb ├── openresty-nginx-plus-lua.html.erb ├── planetscale.html.markerb ├── postgres.html.erb ├── puppeteer-js-renderer.html.erb ├── redis.html.erb ├── redistls.html.erb ├── run-a-global-image-service.html.markerb ├── run-a-private-dns-over-https-service.html.markerb ├── smokescreen.html.erb └── vscode-remote.html.erb ├── apps ├── app-availability.html.markerb ├── build-secrets.html.md ├── concurrency.html.markerb ├── delete.html.markerb ├── fine-tune-apps.html.markerb ├── going-to-production.html.markerb ├── index.html.markerb ├── info.html.md ├── move-app-org.html.markerb ├── overview.html.markerb ├── restart.html.markerb ├── secrets.html.markerb └── trouble-host-unavailable.html.markerb ├── blueprints ├── autoscale-machines.html.md ├── autostart-internal-apps.html.md ├── bridge-deployments-wireguard.html.md ├── cell-based.html.md ├── connect-private-network-wireguard │ ├── index.html.md │ └── wireguard-activate.mp4 ├── connecting-to-user-machines-http-flow.svg ├── connecting-to-user-machines.html.md ├── connecting-to-user-machines.mmd ├── deno-kv-litefs.html.markerb ├── going-to-production-with-healthcare-apps.html.md ├── index.html.erb ├── multi-region-fly-replay.html.md ├── observability-for-user-apps.html.md ├── opensshd.html.md ├── per-user-dev-environments.html.md ├── private-applications-flycast.html.md ├── remote-mcp-servers.html.md ├── resilient-apps-multiple-machines.html.md ├── review-apps-guide.html.md ├── setting-concurrency-limits.html.md ├── shared-nothing.html.markerb ├── staging-prod-isolation.html.md ├── sticky-sessions.html.md ├── supercronic.html.md ├── using-base-images-for-faster-deployments.html.md └── using-the-fly-docker-registry.html.md ├── build └── assets │ ├── manifest-e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.js │ ├── manifest-e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.js.gz │ └── manifest.json ├── containers.html.md ├── database-storage-guides.html.md ├── deep-dive ├── application.html.markerb ├── django.html.markerb ├── index.html.markerb ├── launch-deep-dive.html.markerb ├── nextjs.html.markerb ├── nodejs.html.markerb ├── phoenix.html.markerb ├── postgresql.html.markerb ├── rails.html.markerb ├── recap.html.markerb ├── redis.html.markerb ├── tigris.html.markerb └── whisper.html.markerb ├── django ├── advanced-guides.html.md ├── advanced-guides │ └── staging-environments-with-github-actions.html.md ├── getting-started │ ├── existing.html.md │ └── index.html.md └── index.html.markerb ├── elixir ├── advanced-guides.html.md ├── advanced-guides │ ├── clustering-from-home-to-your-app-in-fly.html.md │ ├── connect-livebook-to-your-app.html.md │ ├── connect-observer-to-your-app.html.md │ ├── github-actions-elixir-ci-cd.html.md │ ├── interesting-things-with-livebook.html.md │ └── sqlite3.html.md ├── getting-started │ ├── existing.html.markerb │ ├── index.html.markerb │ ├── legacy.html.markerb │ └── migrate-from-heroku.html.markerb ├── index.html.md ├── the-basics.html.md └── the-basics │ ├── clustering.html.md │ ├── iex-into-running-app.html.md │ ├── oban.md │ └── troubleshooting.html.md ├── flyctl ├── cmd │ ├── fly.md │ ├── fly_agent.md │ ├── fly_agent_ping.md │ ├── fly_agent_restart.md │ ├── fly_agent_run.md │ ├── fly_agent_start.md │ ├── fly_agent_stop.md │ ├── fly_apps.md │ ├── fly_apps_create.md │ ├── fly_apps_destroy.md │ ├── fly_apps_errors.md │ ├── fly_apps_list.md │ ├── fly_apps_move.md │ ├── fly_apps_open.md │ ├── fly_apps_releases.md │ ├── fly_apps_restart.md │ ├── fly_auth.md │ ├── fly_auth_docker.md │ ├── fly_auth_login.md │ ├── fly_auth_logout.md │ ├── fly_auth_signup.md │ ├── fly_auth_whoami.md │ ├── fly_certs.md │ ├── fly_certs_add.md │ ├── fly_certs_check.md │ ├── fly_certs_list.md │ ├── fly_certs_remove.md │ ├── fly_certs_show.md │ ├── fly_checks.md │ ├── fly_checks_list.md │ ├── fly_config.md │ ├── fly_config_env.md │ ├── fly_config_save.md │ ├── fly_config_show.md │ ├── fly_config_validate.md │ ├── fly_console.md │ ├── fly_consul.md │ ├── fly_consul_attach.md │ ├── fly_consul_detach.md │ ├── fly_dashboard.md │ ├── fly_dashboard_metrics.md │ ├── fly_deploy.md │ ├── fly_dig.md │ ├── fly_docs.md │ ├── fly_doctor.md │ ├── fly_doctor_diag.md │ ├── fly_extensions.md │ ├── fly_extensions_arcjet.md │ ├── fly_extensions_arcjet_create.md │ ├── fly_extensions_arcjet_dashboard.md │ ├── fly_extensions_arcjet_destroy.md │ ├── fly_extensions_arcjet_list.md │ ├── fly_extensions_arcjet_status.md │ ├── fly_extensions_enveloop.md │ ├── fly_extensions_enveloop_create.md │ ├── fly_extensions_enveloop_dashboard.md │ ├── fly_extensions_enveloop_destroy.md │ ├── fly_extensions_enveloop_list.md │ ├── fly_extensions_enveloop_status.md │ ├── fly_extensions_kubernetes.md │ ├── fly_extensions_kubernetes_create.md │ ├── fly_extensions_kubernetes_destroy.md │ ├── fly_extensions_kubernetes_list.md │ ├── fly_extensions_kubernetes_save-kubeconfig.md │ ├── fly_extensions_mysql.md │ ├── fly_extensions_mysql_create.md │ ├── fly_extensions_mysql_destroy.md │ ├── fly_extensions_mysql_list.md │ ├── fly_extensions_mysql_status.md │ ├── fly_extensions_mysql_update.md │ ├── fly_extensions_sentry.md │ ├── fly_extensions_sentry_create.md │ ├── fly_extensions_sentry_dashboard.md │ ├── fly_extensions_sentry_destroy.md │ ├── fly_extensions_sentry_list.md │ ├── fly_extensions_storage.md │ ├── fly_extensions_storage_create.md │ ├── fly_extensions_storage_dashboard.md │ ├── fly_extensions_storage_destroy.md │ ├── fly_extensions_storage_list.md │ ├── fly_extensions_storage_status.md │ ├── fly_extensions_storage_update.md │ ├── fly_extensions_supabase.md │ ├── fly_extensions_supabase_dashboard.md │ ├── fly_extensions_supabase_destroy.md │ ├── fly_extensions_supabase_list.md │ ├── fly_extensions_supabase_status.md │ ├── fly_extensions_vector.md │ ├── fly_extensions_vector_create.md │ ├── fly_extensions_vector_dashboard.md │ ├── fly_extensions_vector_destroy.md │ ├── fly_extensions_vector_list.md │ ├── fly_extensions_vector_status.md │ ├── fly_extensions_wafris.md │ ├── fly_extensions_wafris_create.md │ ├── fly_extensions_wafris_dashboard.md │ ├── fly_extensions_wafris_destroy.md │ ├── fly_image.md │ ├── fly_image_show.md │ ├── fly_image_update.md │ ├── fly_incidents.md │ ├── fly_incidents_hosts.md │ ├── fly_incidents_hosts_list.md │ ├── fly_incidents_list.md │ ├── fly_ips.md │ ├── fly_ips_allocate-v4.md │ ├── fly_ips_allocate-v6.md │ ├── fly_ips_list.md │ ├── fly_ips_private.md │ ├── fly_ips_release.md │ ├── fly_jobs.md │ ├── fly_jobs_open.md │ ├── fly_launch.md │ ├── fly_litefs-cloud.md │ ├── fly_litefs-cloud_clusters.md │ ├── fly_litefs-cloud_clusters_create.md │ ├── fly_litefs-cloud_clusters_destroy.md │ ├── fly_litefs-cloud_clusters_list.md │ ├── fly_litefs-cloud_export.md │ ├── fly_litefs-cloud_import.md │ ├── fly_litefs-cloud_regions.md │ ├── fly_litefs-cloud_restore.md │ ├── fly_litefs-cloud_status.md │ ├── fly_logs.md │ ├── fly_machine.md │ ├── fly_machine_api-proxy.md │ ├── fly_machine_clone.md │ ├── fly_machine_cordon.md │ ├── fly_machine_create.md │ ├── fly_machine_destroy.md │ ├── fly_machine_egress-ip.md │ ├── fly_machine_egress-ip_allocate.md │ ├── fly_machine_egress-ip_list.md │ ├── fly_machine_egress-ip_release.md │ ├── fly_machine_exec.md │ ├── fly_machine_kill.md │ ├── fly_machine_leases.md │ ├── fly_machine_leases_clear.md │ ├── fly_machine_leases_view.md │ ├── fly_machine_list.md │ ├── fly_machine_place.md │ ├── fly_machine_restart.md │ ├── fly_machine_run.md │ ├── fly_machine_start.md │ ├── fly_machine_status.md │ ├── fly_machine_stop.md │ ├── fly_machine_suspend.md │ ├── fly_machine_uncordon.md │ ├── fly_machine_update.md │ ├── fly_managed-postgres.md │ ├── fly_managed-postgres_attach.md │ ├── fly_managed-postgres_connect.md │ ├── fly_managed-postgres_create.md │ ├── fly_managed-postgres_list.md │ ├── fly_managed-postgres_proxy.md │ ├── fly_managed-postgres_status.md │ ├── fly_mcp.md │ ├── fly_mcp_add.md │ ├── fly_mcp_destroy.md │ ├── fly_mcp_inspect.md │ ├── fly_mcp_launch.md │ ├── fly_mcp_list.md │ ├── fly_mcp_logs.md │ ├── fly_mcp_proxy.md │ ├── fly_mcp_remove.md │ ├── fly_mcp_server.md │ ├── fly_mcp_wrap.md │ ├── fly_mysql.md │ ├── fly_mysql_create.md │ ├── fly_mysql_destroy.md │ ├── fly_mysql_list.md │ ├── fly_mysql_status.md │ ├── fly_mysql_update.md │ ├── fly_orgs.md │ ├── fly_orgs_create.md │ ├── fly_orgs_delete.md │ ├── fly_orgs_invite.md │ ├── fly_orgs_list.md │ ├── fly_orgs_remove.md │ ├── fly_orgs_show.md │ ├── fly_ping.md │ ├── fly_platform.md │ ├── fly_platform_regions.md │ ├── fly_platform_status.md │ ├── fly_platform_vm-sizes.md │ ├── fly_postgres.md │ ├── fly_postgres_attach.md │ ├── fly_postgres_backup.md │ ├── fly_postgres_backup_config.md │ ├── fly_postgres_backup_config_show.md │ ├── fly_postgres_backup_config_update.md │ ├── fly_postgres_backup_create.md │ ├── fly_postgres_backup_enable.md │ ├── fly_postgres_backup_list.md │ ├── fly_postgres_backup_restore.md │ ├── fly_postgres_config.md │ ├── fly_postgres_config_show.md │ ├── fly_postgres_config_update.md │ ├── fly_postgres_connect.md │ ├── fly_postgres_create.md │ ├── fly_postgres_db.md │ ├── fly_postgres_db_list.md │ ├── fly_postgres_detach.md │ ├── fly_postgres_events.md │ ├── fly_postgres_events_list.md │ ├── fly_postgres_failover.md │ ├── fly_postgres_import.md │ ├── fly_postgres_list.md │ ├── fly_postgres_renew-certs.md │ ├── fly_postgres_restart.md │ ├── fly_postgres_users.md │ ├── fly_postgres_users_list.md │ ├── fly_proxy.md │ ├── fly_redis.md │ ├── fly_redis_connect.md │ ├── fly_redis_create.md │ ├── fly_redis_dashboard.md │ ├── fly_redis_destroy.md │ ├── fly_redis_list.md │ ├── fly_redis_plans.md │ ├── fly_redis_proxy.md │ ├── fly_redis_reset.md │ ├── fly_redis_status.md │ ├── fly_redis_update.md │ ├── fly_releases.md │ ├── fly_scale.md │ ├── fly_scale_count.md │ ├── fly_scale_memory.md │ ├── fly_scale_show.md │ ├── fly_scale_vm.md │ ├── fly_secrets.md │ ├── fly_secrets_deploy.md │ ├── fly_secrets_import.md │ ├── fly_secrets_list.md │ ├── fly_secrets_set.md │ ├── fly_secrets_unset.md │ ├── fly_services.md │ ├── fly_services_list.md │ ├── fly_settings.md │ ├── fly_settings_analytics.md │ ├── fly_settings_analytics_disable.md │ ├── fly_settings_analytics_enable.md │ ├── fly_settings_autoupdate.md │ ├── fly_settings_autoupdate_disable.md │ ├── fly_settings_autoupdate_enable.md │ ├── fly_settings_synthetics.md │ ├── fly_settings_synthetics_disable.md │ ├── fly_settings_synthetics_enable.md │ ├── fly_sftp.md │ ├── fly_sftp_find.md │ ├── fly_sftp_get.md │ ├── fly_sftp_shell.md │ ├── fly_ssh.md │ ├── fly_ssh_console.md │ ├── fly_ssh_issue.md │ ├── fly_ssh_log.md │ ├── fly_ssh_sftp.md │ ├── fly_ssh_sftp_find.md │ ├── fly_ssh_sftp_get.md │ ├── fly_ssh_sftp_shell.md │ ├── fly_status.md │ ├── fly_storage.md │ ├── fly_storage_create.md │ ├── fly_storage_dashboard.md │ ├── fly_storage_destroy.md │ ├── fly_storage_list.md │ ├── fly_storage_status.md │ ├── fly_storage_update.md │ ├── fly_synthetics.md │ ├── fly_synthetics_agent.md │ ├── fly_tokens.md │ ├── fly_tokens_3p.md │ ├── fly_tokens_3p_add-discharge.md │ ├── fly_tokens_3p_add.md │ ├── fly_tokens_3p_discharge.md │ ├── fly_tokens_3p_ticket.md │ ├── fly_tokens_attenuate.md │ ├── fly_tokens_create.md │ ├── fly_tokens_create_deploy.md │ ├── fly_tokens_create_litefs-cloud.md │ ├── fly_tokens_create_machine-exec.md │ ├── fly_tokens_create_org.md │ ├── fly_tokens_create_readonly.md │ ├── fly_tokens_create_ssh.md │ ├── fly_tokens_debug.md │ ├── fly_tokens_list.md │ ├── fly_tokens_revoke.md │ ├── fly_version.md │ ├── fly_version_upgrade.md │ ├── fly_volumes.md │ ├── fly_volumes_create.md │ ├── fly_volumes_destroy.md │ ├── fly_volumes_extend.md │ ├── fly_volumes_fork.md │ ├── fly_volumes_list.md │ ├── fly_volumes_show.md │ ├── fly_volumes_snapshots.md │ ├── fly_volumes_snapshots_create.md │ ├── fly_volumes_snapshots_list.md │ ├── fly_volumes_update.md │ ├── fly_wireguard.md │ ├── fly_wireguard_create.md │ ├── fly_wireguard_list.md │ ├── fly_wireguard_remove.md │ ├── fly_wireguard_reset.md │ ├── fly_wireguard_token.md │ ├── fly_wireguard_token_create.md │ ├── fly_wireguard_token_delete.md │ ├── fly_wireguard_token_list.md │ ├── fly_wireguard_token_start.md │ ├── fly_wireguard_token_update.md │ └── fly_wireguard_websockets.md ├── index.html.md ├── install.html.markerb └── integrating.html.md ├── getting-started ├── essentials.html.md ├── get-started-by-framework.html.markerb ├── index.html.md ├── launch-demo.html.markerb ├── launch.html.markerb ├── sign-up-sign-in.html.markerb └── troubleshooting.html.md ├── gpus ├── getting-started-gpus.html.md ├── gpu-quickstart.html.markerb ├── index.html.md └── python-gpu-example.html.md ├── guides.html.markerb ├── hiring ├── company-levels.html.md ├── hiring.html.md ├── index.html.md ├── levels.html.md ├── questions.html.md ├── roles.html.md ├── stack.html.md └── working.html.md ├── images ├── Managed_Postgres.png ├── backends-listing-screenshot.webp ├── channeling2.webp ├── cluster-from-home-to-fly-app-1.png ├── cluster-from-home-to-fly-app-2.png ├── configure.webp ├── configured.webp ├── cpu-quota.png ├── cpu-quota.webp ├── dns-verified.webp ├── elixir-livebook-to-server-fly-overview.webp ├── elixir-wireguard-observer-tunnel.webp ├── enable.webp ├── fauna_region_groups.png ├── fly-region-map.webp ├── flyhostname.webp ├── laravel-app-ssr-vms.png ├── livebook-data-analysis-runtime-click-step1.webp ├── livebook-data-analysis-runtime-click-step2.webp ├── livebook-data-analysis-runtime-click-step3.webp ├── livebook-personality-bar-visualization.webp ├── livebook-personality-pie-visualization.webp ├── livebook-runtime-attach-steps.webp ├── livebook-runtime-link.webp ├── livebook-vegalite-examples.webp ├── mcp-proxy-wrap-flog.png ├── mermaid-diagram-1.png ├── mermaid-diagram-2.png ├── middleware.webp ├── observer-local-node-connected.webp ├── observer-local-node-menu.webp ├── observer-local-node.webp ├── observer-tictac-local-application-pane.webp ├── orgtoken.png ├── planetscale_add_region.webp ├── planetscale_add_region_connect.webp ├── planetscale_add_region_dialog.webp ├── planetscale_arctype_connection_url.webp ├── planetscale_arctype_connections.webp ├── planetscale_arctype_create_table_succeeded.webp ├── planetscale_arctype_new_query.webp ├── planetscale_connect_nodejs.webp ├── planetscale_database_created.webp ├── planetscale_laravel_connection_string.webp ├── planetscale_laravel_new_database.webp ├── planetscale_laravel_new_db_dialog.webp ├── planetscale_misc_delete.webp ├── planetscale_misc_statistics.webp ├── planetscale_new_database_dialog.webp ├── planetscale_promote.webp ├── routes.webp ├── safari-pinned-tab.svg ├── sentient_balloon.webp ├── slack-invite-add-rule.webp ├── slack-invite-backends.webp ├── slack-invite-final.webp ├── slack-invite-hostnames.webp ├── slack-invite-rules.webp ├── tigris-launch-ui.png └── wormhole.webp ├── index.html.md ├── js ├── frameworks.html.markerb ├── frameworks │ ├── astro.html.markerb │ ├── deno.html.markerb │ ├── meteor.html.markerb │ ├── nextjs.html.markerb │ ├── nuxtjs.html.markerb │ ├── partials │ │ ├── _flyctl.html.erb │ │ ├── _intro.html.erb │ │ ├── _launch.html.erb │ │ └── _launched.html.erb │ ├── redwood.html.markerb │ ├── remix.html.markerb │ └── svelte.html.markerb ├── index.html.markerb ├── prisma │ ├── index.html.md │ ├── postgres.html.md │ └── sqlite.html.md ├── shopify.html.markerb ├── the-basics.html.md └── the-basics │ ├── database.html.md │ ├── dependencies.html.md │ ├── dockerfiles.html.md │ ├── listening-ports.html.md │ ├── object-storage.html.md │ ├── scaling.html.md │ ├── secrets.html.md │ └── volumes.html.md ├── kubernetes ├── clusters.html.markerb ├── connect-clusters.html.markerb ├── fks-features.html.markerb ├── fks-quickstart.html.markerb ├── index.html.markerb ├── services.html.markerb ├── using-gpus.html.markerb └── using-volumes.html.markerb ├── languages-and-frameworks ├── crystal.html.markerb ├── dockerfile.html.markerb ├── dotnet.html.markerb ├── golang.html.markerb ├── index.html.erb ├── partials │ ├── _flyctl.html.erb │ ├── _install_flyctl_login.html.erb │ ├── _intro.html.erb │ ├── _launch.html.erb │ ├── _launch_with_postgres.html.erb │ ├── _launched.html.erb │ └── _scanner_guides.html.erb ├── ruby.html.markerb ├── static.html.markerb └── wordpress.html.markerb ├── laravel ├── advanced-guides.html.md ├── advanced-guides │ ├── customizing-dockerfile.html.md │ ├── github-actions.html.md │ ├── global-sqlite-litefs.html.markerb │ ├── multiple-applications.html.md │ ├── using-inertia-ssr.html.md │ └── using-symfony.html.md ├── database-guides.html.md ├── database-guides │ ├── laravel-db-migrations.html.markerb │ ├── laravel-mysql.html.markerb │ ├── laravel-pgsql.html.markerb │ ├── laravel-redis.html.markerb │ └── laravel-sqlite.html.markerb ├── index.html.markerb ├── the-basics.html.md └── the-basics │ ├── cron-and-queues.html.md │ ├── customizing-deployments.html.md │ ├── laravel-tigris-file-storage.html.markerb │ ├── laravel-volume-storage.html.markerb │ ├── logging-stack-traces.html.md │ ├── php-node-version.html.md │ └── post-deployment.html.md ├── launch ├── autoscale-by-metric.html.markerb ├── autostop-autostart.html.markerb ├── continuous-deployment-with-github-actions.html.md ├── create.html.markerb ├── deploy.html.markerb ├── index.html.markerb ├── monorepo.html.md ├── processes.html.markerb ├── scale-count.html.markerb ├── scale-machine.html.markerb └── volume-storage.html.markerb ├── litefs ├── backup.html.markerb ├── cloud-backups.html.markerb ├── cloud-restore.html.markerb ├── config.html.markerb ├── disaster-recovery.html.markerb ├── events.html.markerb ├── export.html.markerb ├── faq.html.markerb ├── getting-started-docker.html.markerb ├── getting-started-fly.html.markerb ├── how-it-works.html.markerb ├── import.html.markerb ├── index.html.markerb ├── migrations.html.markerb ├── mount.html.markerb ├── position.html.markerb ├── primary.html.markerb ├── proxy.html.markerb ├── releases.html.markerb ├── run.html.markerb └── speedrun.html.markerb ├── machines ├── api │ ├── apps-resource.html.markerb │ ├── index.html.md │ ├── machines-resource.html.markerb │ ├── tokens-resource.html.markerb │ ├── volumes-resource.html.markerb │ └── working-with-machines-api.html.markerb ├── cpu-performance.html.md ├── flyctl │ ├── fly-machine-run.html.md │ └── fly-machine-update.html.md ├── guides-examples.html.md ├── guides-examples │ ├── functions-with-machines.html.markerb │ ├── images │ │ ├── testrun-err-empty-response.webp │ │ └── testrun-hello.webp │ ├── machine-restart-policy.html.markerb │ ├── machine-sizing.html.markerb │ ├── machines-app-using-flyctl.html.markerb │ ├── network-policies.html.markerb │ └── one-app-per-user-why.html.markerb ├── index.html.md ├── machine-states.html.markerb ├── overview.html.markerb └── runtime-environment.html.md ├── mcp ├── access-control.html.erb ├── access-control │ ├── flycast.html.md │ ├── http-authorization.html.md │ └── reverse-proxy.html.md ├── deploy-on.html.markerb ├── deploy-on │ ├── container.html.md │ ├── fly-machine.html.md │ └── your-app.html.md ├── deploy-with.html.markerb ├── deploy-with │ ├── fly-launch.html.md │ ├── flyctl-machines.html.md │ └── machines-api.html.md ├── examples.html.md ├── flyctl-server.html.md ├── index.html.markerb ├── launch.html.md ├── transports.html.md └── transports │ ├── sse.html.md │ ├── stdio.html.md │ └── streaming-http.html.md ├── monitoring ├── error-codes.html.md ├── exporting-logs.html.md ├── index.html.markerb ├── live-tail-logs.html.markerb ├── logging-overview.html.markerb ├── metrics.html.md ├── search-logs.html.markerb └── sentry.html.md ├── mpg ├── index.html.md └── overview.html.md ├── networking ├── app-services.html.md ├── custom-domain-api.html.markerb ├── custom-domain.html.markerb ├── custom-private-networks.html.markerb ├── dynamic-request-routing.html.markerb ├── flycast.html.markerb ├── index.html.markerb ├── private-networking.html.md ├── request-headers.html.md ├── services.html.markerb ├── tls.html.md └── udp-and-tcp.html.markerb ├── partials ├── _accordion.html.erb ├── _accordion_nav.html.erb ├── _apps_nav.html.erb ├── _back_to_docs.html.erb ├── _breadcrumbs.html.erb ├── _demo_nav.html.erb ├── _devjobs_nav.html.erb ├── _firecracker_nav.html.erb ├── _flyctl_nav.html.erb ├── _hands_on_nav.html.erb ├── _legacy_apps_doc.html.erb ├── _litefs_nav.html.erb ├── _machines_nav.html.erb ├── _machines_toc_nav.html.erb ├── _obsolete_doc.html.erb ├── _set_secrets.html.erb ├── _sign_in.html.erb ├── _sign_up.html.erb ├── _simple_list.html.erb ├── _v2_needs_update.erb ├── docs │ ├── _flyctl_install.html.erb │ ├── _litefs_sunset.html.erb │ └── _volumes_access.html.erb ├── flyctl │ ├── _apps_create.html.erb │ └── _auth_login.html.erb ├── gpus │ └── _ollama-create.erb ├── postgres │ └── _pg-create.erb └── tigris │ └── _tigris-storage-create.erb ├── postgres ├── advanced-guides.html.md ├── advanced-guides │ └── high-availability-and-global-replication.html.markerb ├── connecting.html.md ├── connecting │ ├── app-connection-examples.html.markerb │ ├── connecting-external.html.markerb │ ├── connecting-internal.html.markerb │ └── connecting-with-flyctl.html.markerb ├── getting-started.html.markerb ├── getting-started │ ├── create-pg-cluster.html.markerb │ ├── enabling-timescale.html.markerb │ ├── migrate-from-heroku.html.md │ └── what-you-should-know.html.md ├── index.html.md ├── managing.html.markerb └── managing │ ├── attach-detach.html.markerb │ ├── backup-and-restore.html.markerb │ ├── cluster-resources.html.markerb │ ├── configuration-tuning.html.markerb │ ├── deleting.html.markerb │ ├── forking.html.markerb │ ├── horizontal-scaling.html.markerb │ ├── monitoring.html.markerb │ ├── scale-to-zero.html.markerb │ ├── scaling.html.markerb │ ├── upgrades.html.markerb │ └── users-and-roles.html.markerb ├── python ├── do-more.html.md ├── do-more │ ├── add-object-storage.html.markerb │ ├── add-ollama.html.markerb │ └── add-postgres.html.markerb ├── frameworks.html.markerb ├── frameworks │ ├── fastapi.html.markerb │ ├── flask.html.markerb │ └── streamlit.html.markerb ├── index.html.md ├── partials │ ├── _deploy.erb │ ├── _poetry_new.erb │ └── _speedrun.erb ├── the-basics.html.md └── the-basics │ ├── initial-setup.html.md │ └── multi-stage-builds.html.md ├── rails ├── advanced-guides.html.md ├── advanced-guides │ ├── anycable.html.md │ ├── litefs.html.md │ ├── machine.html.md │ ├── multi-region.html.md │ ├── multiple-applications.html.md │ ├── phusion-passenger.html.md │ └── sqlite3.html.md ├── cookbooks │ ├── api.html.markerb │ ├── api │ │ └── Dockerfile1 │ ├── build.html.markerb │ ├── databases.html.markerb │ ├── databases │ │ ├── Dockerfile1 │ │ ├── Dockerfile2 │ │ └── Dockerfile3 │ ├── deploy.html.markerb │ ├── index.html.md │ ├── minimal.html.markerb │ ├── minimal │ │ ├── Dockerfile1 │ │ ├── Dockerfile2 │ │ └── Dockerfile3 │ ├── node.html.markerb │ ├── node │ │ ├── Dockerfile1 │ │ ├── Dockerfile2 │ │ ├── Dockerfile3 │ │ ├── Dockerfile4 │ │ ├── Dockerfile5 │ │ └── Dockerfile6 │ ├── sources.html.markerb │ └── sources │ │ ├── Dockerfile1 │ │ ├── Dockerfile2 │ │ └── Dockerfile3 ├── getting-started │ ├── dockerfiles.html.md │ ├── existing.html.md │ ├── fly-rails.html.md │ ├── index.html.md │ └── migrate-from-heroku.html.md ├── index.html.markerb ├── one-pager.html.md ├── the-basics.html.md └── the-basics │ ├── active-record.html.md │ ├── active-storage.html.md │ ├── configuration.html.md │ ├── deployments.html.md │ ├── run-tasks-and-consoles.html.md │ ├── sidekiq.html.md │ └── turbo-streams-and-action-cable.html.md ├── reference ├── architecture.html.md ├── autoscaling.html.md ├── builders.html.md ├── configuration.html.markerb ├── enveloop.html.md ├── extensions_api.html.md ├── fly-launch.html.md ├── fly-proxy-autostop-autostart.html.markerb ├── fly-proxy.html.markerb ├── health-checks.html.markerb ├── index.html.md ├── load-balancing.html.md ├── machine-migration.html.markerb ├── machines │ ├── _create_app.erb │ ├── _create_app_req.erb │ ├── _create_req.erb │ ├── _create_resp.erb │ ├── _delete.erb │ ├── _delete_app.erb │ ├── _delete_app_req.erb │ ├── _delete_app_resp.erb │ ├── _delete_req.erb │ ├── _delete_resp.erb │ ├── _get.erb │ ├── _get_app.erb │ ├── _get_app_req.erb │ ├── _get_app_resp.erb │ ├── _get_req.erb │ ├── _get_resp.erb │ ├── _launch.erb │ ├── _launch_req.erb │ ├── _launch_resp.erb │ ├── _launch_syd_req.erb │ ├── _launch_syd_resp.erb │ ├── _lease.erb │ ├── _lease_req.erb │ ├── _lease_resp.erb │ ├── _list.erb │ ├── _list_req.erb │ ├── _list_resp.erb │ ├── _machines_cordon_req.erb │ ├── _machines_create_req.erb │ ├── _machines_create_resp.erb │ ├── _machines_create_serv_req.erb │ ├── _machines_create_serv_resp.erb │ ├── _machines_delete_req.erb │ ├── _machines_get_req.erb │ ├── _machines_get_resp.erb │ ├── _machines_lease_create_req.erb │ ├── _machines_lease_create_resp.erb │ ├── _machines_lease_get_req.erb │ ├── _machines_lease_get_resp.erb │ ├── _machines_lease_release_req.erb │ ├── _machines_lease_release_resp.erb │ ├── _machines_list_req.erb │ ├── _machines_list_resp.erb │ ├── _machines_metadata_delete_req.erb │ ├── _machines_metadata_delete_resp.erb │ ├── _machines_metadata_get_req.erb │ ├── _machines_metadata_get_resp.erb │ ├── _machines_metadata_update_req.erb │ ├── _machines_metadata_update_resp.erb │ ├── _machines_ok_true_resp.erb │ ├── _machines_start_req.erb │ ├── _machines_start_resp.erb │ ├── _machines_stop_req.erb │ ├── _machines_suspend_req.erb │ ├── _machines_uncordon_req.erb │ ├── _machines_update_req.erb │ ├── _machines_update_resp.erb │ ├── _machines_wait_req.erb │ ├── _start.erb │ ├── _start_req.erb │ ├── _start_resp.erb │ ├── _stop.erb │ ├── _stop_req.erb │ ├── _stop_resp.erb │ ├── _update.erb │ ├── _update_req.erb │ ├── _update_resp.erb │ ├── _wait.erb │ ├── _wait_req.erb │ └── _wait_resp.erb ├── postgres-whats-next.html.md └── regions.html.markerb ├── retired-launcher.html.md ├── rust ├── frameworks.html.markerb ├── frameworks │ ├── actix-web.html.markerb │ ├── axum.html.markerb │ ├── dioxus-liveview.html.markerb │ ├── poem.html.markerb │ ├── rocket.html.markerb │ └── warp.html.markerb ├── index.html.md ├── partials │ ├── _cargo-new.html.erb │ ├── _deploy.html.erb │ └── _speedrun.html.erb ├── the-basics.html.md └── the-basics │ └── cargo-chef.html.md ├── security ├── arcjet.html.md ├── index.html.markerb ├── openid-connect.html.markerb ├── remove-org-member.html.markerb ├── security-at-fly-io.html.md ├── shared-responsibility.html.markerb ├── sso.html.markerb ├── tls-termination.html.markerb └── tokens.html.markerb ├── signup-welcome.html.md ├── styles ├── Fly │ ├── Exclamation.yml │ ├── Headings.yml │ ├── Latin.yml │ ├── Machine.yml │ ├── OxfordComma.yml │ ├── SentenceLength.yml │ ├── Spelling.yml │ ├── Us.yml │ └── WordList.yml ├── Google │ ├── AMPM.yml │ ├── Acronyms.yml │ ├── Colons.yml │ ├── Contractions.yml │ ├── DateFormat.yml │ ├── Ellipses.yml │ ├── EmDash.yml │ ├── EnDash.yml │ ├── Exclamation.yml │ ├── FirstPerson.yml │ ├── Gender.yml │ ├── GenderBias.yml │ ├── HeadingPunctuation.yml │ ├── Headings.yml │ ├── Latin.yml │ ├── LyHyphens.yml │ ├── OptionalPlurals.yml │ ├── Ordinal.yml │ ├── OxfordComma.yml │ ├── Parens.yml │ ├── Passive.yml │ ├── Periods.yml │ ├── Quotes.yml │ ├── Ranges.yml │ ├── Semicolons.yml │ ├── Slang.yml │ ├── Spacing.yml │ ├── Spelling.yml │ ├── Units.yml │ ├── We.yml │ ├── Will.yml │ ├── WordList.yml │ ├── meta.json │ └── vocab.txt ├── config │ └── vocabularies │ │ └── fly-terms │ │ ├── accept.txt │ │ └── reject.txt ├── proselint │ ├── Airlinese.yml │ ├── AnimalLabels.yml │ ├── Annotations.yml │ ├── Apologizing.yml │ ├── Archaisms.yml │ ├── But.yml │ ├── Cliches.yml │ ├── CorporateSpeak.yml │ ├── Currency.yml │ ├── Cursing.yml │ ├── DateCase.yml │ ├── DateMidnight.yml │ ├── DateRedundancy.yml │ ├── DateSpacing.yml │ ├── DenizenLabels.yml │ ├── Diacritical.yml │ ├── GenderBias.yml │ ├── GroupTerms.yml │ ├── Hedging.yml │ ├── Hyperbole.yml │ ├── Jargon.yml │ ├── LGBTOffensive.yml │ ├── LGBTTerms.yml │ ├── Malapropisms.yml │ ├── Needless.yml │ ├── Nonwords.yml │ ├── Oxymorons.yml │ ├── P-Value.yml │ ├── RASSyndrome.yml │ ├── README.md │ ├── Skunked.yml │ ├── Spelling.yml │ ├── Typography.yml │ ├── Uncomparables.yml │ ├── Very.yml │ └── meta.json ├── words2ignore.txt └── write-good │ ├── Cliches.yml │ ├── E-Prime.yml │ ├── Illusions.yml │ ├── Passive.yml │ ├── README.md │ ├── So.yml │ ├── ThereIs.yml │ ├── TooWordy.yml │ ├── Weasel.yml │ └── meta.json ├── supabase └── index.html.md ├── tigris └── index.html.markerb ├── upstash ├── kafka.html.md ├── redis.html.md └── vector.html.md └── volumes ├── index.html.markerb ├── overview.html.markerb ├── snapshots.html.markerb ├── volume-manage.html.markerb └── volume-states.html.markerb /.buildkite/pipeline.yml: -------------------------------------------------------------------------------- 1 | steps: 2 | - trigger: "landing" 3 | label: "docs update: ${BUILDKITE_MESSAGE}" 4 | branches: main 5 | 6 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/improve-docs-content.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Improve docs content 3 | about: Suggest improvements or report an error or omission in the docs 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Link to the affected page or pages** 11 | Provide URLs of pages on fly.io/docs. 12 | 13 | **Describe what parts of the doc need improvement** 14 | Provide lots of detail about your suggestion for improvement or about the error or omission that you found. If applicable, let us know how you would fix the content. 15 | 16 | **Additional info** 17 | Add any other context about the issue here. If applicable, add screenshots to help explain the suggestion or error. 18 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/improve-the-fly-io-docs-site.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Improve the fly.io/docs site 3 | about: Suggest improvements or report a site or display error. 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Link to the affected page or pages** 11 | If applicable, provide URLs of pages on fly.io/docs. 12 | 13 | **Describe what part of the site needs improvement** 14 | Provide lots of detail about what's going wrong with the navigation or display of the site. 15 | 16 | **Additional info** 17 | Add any other context about the issue here. Add screenshots to help explain the suggestion or error. 18 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | ### Summary of changes 2 | 3 | ### Preview 4 | 5 | ### Related Fly.io community and GitHub links 6 | 7 | ### Notes 8 | 9 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | partials/github 2 | .DS_Store -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Fly.io docs 2 | 3 | https://fly.io/docs 4 | -------------------------------------------------------------------------------- /app-guides/6pndemochat.html.erb: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Chat: A 6PN Example with NATS" 3 | layout: docs 4 | sitemap: false 5 | nav: firecracker 6 | author: dj 7 | source: https://github.com/fly-apps/6pn-demo-chat/ 8 | categories: 9 | - app 10 | - msg 11 | - 6pn 12 | date: 2021-01-12 13 | --- 14 | 15 | <%= partial "/docs/partials/obsolete_doc" %> 16 | <%= github_render("fly-examples/6pn-demo-chat/main/README.md") %> 17 | -------------------------------------------------------------------------------- /app-guides/git-gogs-server.html.erb: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Appkata: Gogs - standalone Git Server" 3 | layout: docs 4 | sitemap: false 5 | nav: firecracker 6 | author: dj 7 | source: https://github.com/fly-apps/appkata-gogs/ 8 | categories: 9 | - dev 10 | - collab 11 | - web 12 | - volumes 13 | date: 2020-8-20 14 | --- 15 | <%= partial "/docs/partials/obsolete_doc" %> 16 | <%= github_render("fly-examples/appkata-gogs/main/README.md") %> 17 | -------------------------------------------------------------------------------- /app-guides/graphql-edge-caching-apollo.html.erb: -------------------------------------------------------------------------------- 1 | --- 2 | title: Apollo GraphQL + Edge Caching 3 | layout: docs 4 | sitemap: false 5 | nav: firecracker 6 | author: karllhughes 7 | source: https://github.com/fly-apps/edge-apollo-cache/ 8 | categories: 9 | - graphql 10 | - apigw 11 | - cache 12 | - performance 13 | image: https://fly.io/ui/images/continuous-deployment.webp 14 | date: 2020-06-21 15 | --- 16 | <%= partial "/docs/partials/obsolete_doc" %> 17 | 18 | <%= github_render("fly-examples/edge-apollo-cache/master/README.md") %> 19 | -------------------------------------------------------------------------------- /app-guides/grpc-and-grpc-web-services.html.erb: -------------------------------------------------------------------------------- 1 | --- 2 | title: Deploy gRPC and gRPC-Web Services 3 | layout: docs 4 | sitemap: false 5 | nav: firecracker 6 | author: sudhirj 7 | source: https://github.com/fly-apps/grpc-service 8 | categories: 9 | - rpc 10 | - lowlevel 11 | date: 2020-10-22 12 | --- 13 | 14 | <%= partial "/docs/partials/obsolete_doc" %> 15 | <%= github_render("fly-examples/grpc-service/master/README.md") %> 16 | -------------------------------------------------------------------------------- /app-guides/kong-api-gateway.html.erb: -------------------------------------------------------------------------------- 1 | --- 2 | title: Kong API gateway 3 | layout: docs 4 | sitemap: false 5 | nav: firecracker 6 | author: karllhughes 7 | source: https://github.com/fly-apps/kong-api-gateway/ 8 | categories: 9 | - apigw 10 | - proxy 11 | - json 12 | date: 2020-04-23 13 | --- 14 | <%= partial "/docs/partials/obsolete_doc" %> 15 | 16 | <%= github_render("fly-examples/kong-api-gateway/main/README.md") %> 17 | -------------------------------------------------------------------------------- /app-guides/mqtt.html.erb: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Appkata: MQTT - Event driven messaging" 3 | layout: docs 4 | sitemap: false 5 | nav: firecracker 6 | author: dj 7 | source: https://github.com/fly-apps/appkata-mqtt/ 8 | categories: 9 | - app 10 | - certs 11 | - msg 12 | - volumes 13 | date: 2020-11-02 14 | --- 15 | <%= partial "/docs/partials/obsolete_doc" %> 16 | 17 | <%= github_render("fly-examples/appkata-mqtt/main/README.md") %> 18 | -------------------------------------------------------------------------------- /app-guides/nats-cluster.html.erb: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Global NATS Cluster" 3 | layout: docs 4 | sitemap: false 5 | nav: firecracker 6 | author: dj 7 | source: https://github.com/fly-apps/nats-cluster/ 8 | categories: 9 | - messaging 10 | - 6pn 11 | date: 2021-01-07 12 | --- 13 | <%= partial "/docs/partials/obsolete_doc" %> 14 | <%= github_render("fly-examples/nats-cluster/main/README.md") %> 15 | -------------------------------------------------------------------------------- /app-guides/node-red.html.erb: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Appkata: Node-RED - Flow Programming" 3 | layout: docs 4 | sitemap: false 5 | nav: firecracker 6 | author: dj 7 | source: https://github.com/fly-apps/appkata-node-red/ 8 | categories: 9 | - iot 10 | - javascript 11 | - flow 12 | date: 2020-11-03 13 | --- 14 | 15 | <%= partial "/docs/partials/obsolete_doc" %> 16 | <%= github_render("fly-examples/appkata-node-red/main/README.md") %> 17 | -------------------------------------------------------------------------------- /app-guides/openresty-nginx-plus-lua.html.erb: -------------------------------------------------------------------------------- 1 | --- 2 | title: "OpenResty: NGINX + Lua" 3 | layout: docs 4 | sitemap: false 5 | nav: firecracker 6 | author: karllhughes 7 | source: https://github.com/fly-apps/kong-api-gateway/ 8 | categories: 9 | - apigw 10 | - proxy 11 | - nginx 12 | - lua 13 | date: 2020-07-10 14 | 15 | --- 16 | <%= partial "/docs/partials/obsolete_doc" %> 17 | 18 | <%= github_render("fly-examples/openresty-basic/main/README.md") %> 19 | -------------------------------------------------------------------------------- /app-guides/postgres.html.erb: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Postgres: A single server deployment for Fly" 3 | layout: docs 4 | sitemap: false 5 | nav: firecracker 6 | author: dj 7 | source: https://github.com/fly-apps/postgres/ 8 | categories: 9 | - 6pn 10 | - database 11 | - development 12 | date: 2020-11-05 13 | --- 14 | <%= partial "/docs/partials/obsolete_doc" %> 15 | <%= github_render("fly-examples/postgres/main/README.md") %> 16 | -------------------------------------------------------------------------------- /app-guides/puppeteer-js-renderer.html.erb: -------------------------------------------------------------------------------- 1 | --- 2 | title: Puppeteer JS Renderer 3 | layout: docs 4 | sitemap: false 5 | nav: firecracker 6 | author: geshan 7 | source: https://github.com/fly-apps/puppeteer-js-renderer/ 8 | categories: 9 | - app 10 | - puppeteer 11 | date: 2020-07-20 12 | --- 13 | <%= partial "/docs/partials/obsolete_doc" %> 14 | <%= github_render("fly-examples/puppeteer-js-renderer/master/README.md") %> 15 | -------------------------------------------------------------------------------- /app-guides/redis.html.erb: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Redis - standalone Redis Server" 3 | layout: docs 4 | sitemap: false 5 | nav: firecracker 6 | author: kurt 7 | source: https://github.com/fly-apps/redis/ 8 | categories: 9 | - app 10 | - server 11 | - database 12 | - volumes 13 | date: 2020-11-07 14 | --- 15 | <%= partial "/docs/partials/obsolete_doc" %> 16 | <%= github_render("fly-examples/redis/main/README.md") %> 17 | -------------------------------------------------------------------------------- /app-guides/redistls.html.erb: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Appkata: Redistls - Redis Server with TLS" 3 | layout: docs 4 | sitemap: false 5 | nav: firecracker 6 | author: kurt 7 | source: https://github.com/fly-apps/appkata-redistls/ 8 | categories: 9 | - app 10 | - server 11 | - database 12 | - volumes 13 | - certs 14 | date: 2020-11-10 15 | --- 16 | 17 | <%= partial "/docs/partials/obsolete_doc" %> 18 | <%= github_render("fly-examples/appkata-redistls/main/README.md") %> 19 | -------------------------------------------------------------------------------- /app-guides/smokescreen.html.erb: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Smokescreen - Sanitize outbound web requests" 3 | layout: docs 4 | sitemap: false 5 | nav: firecracker 6 | author: dj 7 | source: https://github.com/fly-apps/smokescreen/ 8 | categories: 9 | - proxy 10 | - security 11 | date: 2020-12-01 12 | --- 13 | <%= partial "/docs/partials/obsolete_doc" %> 14 | <%= github_render("fly-examples/smokescreen-example/master/README.md") %> 15 | -------------------------------------------------------------------------------- /app-guides/vscode-remote.html.erb: -------------------------------------------------------------------------------- 1 | --- 2 | title: "VS Code - Remote Server over SSH" 3 | layout: docs 4 | sitemap: false 5 | nav: firecracker 6 | author: 7 | - dj 8 | - jerome 9 | source: https://github.com/fly-apps/vscode-remote/ 10 | categories: 11 | - dev 12 | - volumes 13 | date: 2020-11-20 14 | --- 15 | <%= partial "/docs/partials/obsolete_doc" %> 16 | <%= github_render("fly-examples/vscode-remote/main/README.md") %> 17 | -------------------------------------------------------------------------------- /apps/delete.html.markerb: -------------------------------------------------------------------------------- 1 | --- 2 | title: Delete an app 3 | layout: docs 4 | nav: apps 5 | --- 6 | 7 | You can scale an app right down to zero Machines if you like. But if you're done with a Fly App forever, you can delete it using `fly apps destroy `. 8 | 9 | Once you destroy an app, you can no longer access any part of it, and you'll no longer be charged for any part of it either. This includes Fly Machines, Fly Volumes, IP addresses, secrets, Docker images, and so on. 10 | 11 |
12 | Warning: When you destroy an app, you delete its volumes and volume snapshots. If you want the data from an app's persistent storage, then get the data before you destroy the app. 13 |
-------------------------------------------------------------------------------- /blueprints/connect-private-network-wireguard/wireguard-activate.mp4: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/blueprints/connect-private-network-wireguard/wireguard-activate.mp4 -------------------------------------------------------------------------------- /blueprints/connecting-to-user-machines.mmd: -------------------------------------------------------------------------------- 1 | graph TD; 2 | A[Public HTTP Request] -->|Arrives at| B[Router App: llm-router.fly.dev:443] 3 | B -->|Sets fly-replay| C[Fly Proxy] 4 | C -->|replay| D[User App: llm-user-1234] 5 | D -->|match port 443| E[public:443] 6 | 7 | F[Private HTTP Request] -->|Arrives at| G[Management Gateway: llm-gateway.flycast:9090] 8 | G -->|Sets fly-replay| C 9 | C -->|replay| D 10 | D -->|match port 9090| H[management:9090] -------------------------------------------------------------------------------- /build/assets/manifest-e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/build/assets/manifest-e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.js -------------------------------------------------------------------------------- /build/assets/manifest-e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.js.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/build/assets/manifest-e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.js.gz -------------------------------------------------------------------------------- /build/assets/manifest.json: -------------------------------------------------------------------------------- 1 | {"files":{"manifest-e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.js":{"logical_path":"manifest.js","mtime":"2025-05-15T14:33:13-07:00","size":0,"digest":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855","integrity":"sha256-47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU="}},"assets":{"manifest.js":"manifest-e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.js"}} -------------------------------------------------------------------------------- /containers.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | Title: Running Containers 3 | layout: docs 4 | sitemap: false 5 | nav: firecracker 6 | --- 7 | 8 | Moved! [https://fly.io/docs/](https://fly.io/docs/) 9 | -------------------------------------------------------------------------------- /django/advanced-guides.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Advanced guides 3 | layout: framework_docs_overview 4 | toc: false 5 | order: 2 6 | --- 7 | -------------------------------------------------------------------------------- /elixir/advanced-guides.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Advanced guides 3 | layout: framework_docs_overview 4 | toc: false 5 | order: 3 6 | --- 7 | 8 | Elixir can do some pretty neat things by inheriting abilities from the Erlang 9 | Virtual Machine (BEAM). This provides a set of advanced guides for Elixir 10 | applications running on Fly. 11 | -------------------------------------------------------------------------------- /elixir/the-basics.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: The Basics 3 | layout: framework_docs_overview 4 | toc: false 5 | order: 2 6 | --- 7 | 8 | Most Elixir applications require additional setup beyond provisioning a Postgres database. These guides will help you get through the basics of setting up your Elixir application with pieces of infrastructure commonly found in medium-to-high complexity Elixir applications. 9 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_agent_ping.md: -------------------------------------------------------------------------------- 1 | Ping the Fly agent 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly agent ping [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -h, --help help for ping 13 | -j, --json JSON output 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly agent](/docs/flyctl/agent/) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_agent_restart.md: -------------------------------------------------------------------------------- 1 | Restart the Fly agent 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly agent restart [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -h, --help help for restart 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly agent](/docs/flyctl/agent/) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_agent_run.md: -------------------------------------------------------------------------------- 1 | Run the Fly agent in the foreground 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly agent run [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -h, --help help for run 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly agent](/docs/flyctl/agent/) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_agent_start.md: -------------------------------------------------------------------------------- 1 | Start the Fly agent 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly agent start [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -h, --help help for start 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly agent](/docs/flyctl/agent/) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_agent_stop.md: -------------------------------------------------------------------------------- 1 | Stop the Fly agent 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly agent stop [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -h, --help help for stop 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly agent](/docs/flyctl/agent/) - Commands that manage the Fly agent, a background process that manages flyctl wireguard connections 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_apps_destroy.md: -------------------------------------------------------------------------------- 1 | Delete one or more applications from the Fly platform. 2 | 3 | ## Usage 4 | ~~~ 5 | fly apps destroy [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for destroy 12 | -y, --yes Accept all confirmations 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly apps](/docs/flyctl/apps/) - Manage apps. 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_apps_errors.md: -------------------------------------------------------------------------------- 1 | View application errors on Sentry.io 2 | 3 | ## Usage 4 | ~~~ 5 | fly apps errors [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for errors 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly apps](/docs/flyctl/apps/) - Manage apps. 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_apps_open.md: -------------------------------------------------------------------------------- 1 | Open browser to current deployed application. If an optional relative URI is specified, it is appended 2 | to the root URL of the deployed application. 3 | 4 | 5 | ## Usage 6 | ~~~ 7 | fly apps open [RELATIVE_URI] [flags] 8 | ~~~ 9 | 10 | ## Options 11 | 12 | ~~~ 13 | -a, --app string Application name 14 | -c, --config string Path to application configuration file 15 | -h, --help help for open 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly apps](/docs/flyctl/apps/) - Manage apps. 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_apps_restart.md: -------------------------------------------------------------------------------- 1 | Restart an application. Perform a rolling restart against all running Machines. 2 | 3 | ## Usage 4 | ~~~ 5 | fly apps restart [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | --force-stop Performs a force stop against the target Machine 12 | -h, --help help for restart 13 | --skip-health-checks Restarts app without waiting for health checks 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly apps](/docs/flyctl/apps/) - Manage apps. 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_auth_docker.md: -------------------------------------------------------------------------------- 1 | Adds registry.fly.io to the docker daemon's authenticated 2 | registries. This allows you to push images directly to fly from 3 | the docker cli. 4 | 5 | 6 | ## Usage 7 | ~~~ 8 | fly auth docker [flags] 9 | ~~~ 10 | 11 | ## Options 12 | 13 | ~~~ 14 | -h, --help help for docker 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly auth](/docs/flyctl/auth/) - Manage authentication 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_auth_logout.md: -------------------------------------------------------------------------------- 1 | Log the currently logged-in user out of the Fly platform. 2 | To continue interacting with Fly, the user will need to log in again. 3 | 4 | 5 | ## Usage 6 | ~~~ 7 | fly auth logout [flags] 8 | ~~~ 9 | 10 | ## Options 11 | 12 | ~~~ 13 | -h, --help help for logout 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly auth](/docs/flyctl/auth/) - Manage authentication 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_auth_signup.md: -------------------------------------------------------------------------------- 1 | Creates a new fly account. The command opens the browser 2 | and sends the user to a form to provide appropriate credentials. 3 | 4 | 5 | ## Usage 6 | ~~~ 7 | fly auth signup [flags] 8 | ~~~ 9 | 10 | ## Options 11 | 12 | ~~~ 13 | -h, --help help for signup 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly auth](/docs/flyctl/auth/) - Manage authentication 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_auth_whoami.md: -------------------------------------------------------------------------------- 1 | Show the currently authenticated user 2 | 3 | ## Usage 4 | ~~~ 5 | fly auth whoami [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for whoami 12 | -j, --json JSON output 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly auth](/docs/flyctl/auth/) - Manage authentication 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_certs_add.md: -------------------------------------------------------------------------------- 1 | Add a certificate for an application. Takes a hostname 2 | as a parameter for the certificate. 3 | 4 | ## Usage 5 | ~~~ 6 | fly certs add [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for add 15 | -j, --json JSON output 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly certs](/docs/flyctl/certs/) - Manage certificates 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_certs_check.md: -------------------------------------------------------------------------------- 1 | Checks the DNS configuration for the specified hostname. 2 | Displays results in the same format as the SHOW command. 3 | 4 | ## Usage 5 | ~~~ 6 | fly certs check [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for check 15 | -j, --json JSON output 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly certs](/docs/flyctl/certs/) - Manage certificates 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_certs_list.md: -------------------------------------------------------------------------------- 1 | List the certificates associated with a deployed application. 2 | 3 | ## Usage 4 | ~~~ 5 | fly certs list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for list 14 | -j, --json JSON output 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly certs](/docs/flyctl/certs/) - Manage certificates 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_certs_remove.md: -------------------------------------------------------------------------------- 1 | Removes a certificate from an application. Takes hostname 2 | as a parameter to locate the certificate. 3 | 4 | ## Usage 5 | ~~~ 6 | fly certs remove [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for remove 15 | -y, --yes Accept all confirmations 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly certs](/docs/flyctl/certs/) - Manage certificates 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_certs_show.md: -------------------------------------------------------------------------------- 1 | Shows certificate information for an application. 2 | Takes hostname as a parameter to locate the certificate. 3 | 4 | ## Usage 5 | ~~~ 6 | fly certs show [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for show 15 | -j, --json JSON output 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly certs](/docs/flyctl/certs/) - Manage certificates 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_checks.md: -------------------------------------------------------------------------------- 1 | Manage health checks 2 | 3 | ## Usage 4 | ~~~ 5 | fly checks [command] [flags] 6 | ~~~ 7 | 8 | ## Available Commands 9 | * [list](/docs/flyctl/checks-list/) - List health checks 10 | 11 | ## Options 12 | 13 | ~~~ 14 | -a, --app string Application name 15 | -c, --config string Path to application configuration file 16 | -h, --help help for checks 17 | ~~~ 18 | 19 | ## Global Options 20 | 21 | ~~~ 22 | -t, --access-token string Fly API Access Token 23 | --debug Print additional logs and traces 24 | --verbose Verbose output 25 | ~~~ 26 | 27 | ## See Also 28 | 29 | * [fly](/docs/flyctl/help/) - The Fly.io command line interface 30 | 31 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_checks_list.md: -------------------------------------------------------------------------------- 1 | List health checks 2 | 3 | ## Usage 4 | ~~~ 5 | fly checks list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | --check-name string Filter checks by name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for list 15 | -j, --json JSON output 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly checks](/docs/flyctl/checks/) - Manage health checks 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_config_env.md: -------------------------------------------------------------------------------- 1 | Display an app's runtime environment variables. It displays a section for 2 | secrets and another for config file defined environment variables. 3 | 4 | ## Usage 5 | ~~~ 6 | fly config env [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for env 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly config](/docs/flyctl/config/) - Manage an app's configuration 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_config_validate.md: -------------------------------------------------------------------------------- 1 | Validates an application's config file against the Fly platform to 2 | ensure it is correct and meaningful to the platform. 3 | 4 | ## Usage 5 | ~~~ 6 | fly config validate [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for validate 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly config](/docs/flyctl/config/) - Manage an app's configuration 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_consul.md: -------------------------------------------------------------------------------- 1 | Enable and manage Consul clusters 2 | 3 | ## Usage 4 | ~~~ 5 | fly consul [command] [flags] 6 | ~~~ 7 | 8 | ## Available Commands 9 | * [attach](/docs/flyctl/consul-attach/) - Attach Consul cluster to an app 10 | * [detach](/docs/flyctl/consul-detach/) - Detach Consul cluster from an app 11 | 12 | ## Options 13 | 14 | ~~~ 15 | -h, --help help for consul 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly](/docs/flyctl/help/) - The Fly.io command line interface 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_dashboard_metrics.md: -------------------------------------------------------------------------------- 1 | Open web browser on Fly Web UI for this application's metrics 2 | 3 | ## Usage 4 | ~~~ 5 | fly dashboard metrics [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for metrics 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly dashboard](/docs/flyctl/dashboard/) - Open web browser on Fly Web UI for this app 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_docs.md: -------------------------------------------------------------------------------- 1 | View Fly documentation on the Fly.io website. This command will open a 2 | browser to view the content. 3 | 4 | 5 | ## Usage 6 | ~~~ 7 | fly docs [flags] 8 | ~~~ 9 | 10 | ## Options 11 | 12 | ~~~ 13 | -h, --help help for docs 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly](/docs/flyctl/help/) - The Fly.io command line interface 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_arcjet_destroy.md: -------------------------------------------------------------------------------- 1 | Permanently destroy an Arcjet site 2 | 3 | ## Usage 4 | ~~~ 5 | fly extensions arcjet destroy [name] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for destroy 14 | -y, --yes Accept all confirmations 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly extensions arcjet](/docs/flyctl/extensions-arcjet/) - Provision and manage Arcjet 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_arcjet_list.md: -------------------------------------------------------------------------------- 1 | List your Arcjet sites 2 | 3 | ## Usage 4 | ~~~ 5 | fly extensions arcjet list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for list 12 | -o, --org string The target Fly.io organization 13 | -y, --yes Accept all confirmations 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly extensions arcjet](/docs/flyctl/extensions-arcjet/) - Provision and manage Arcjet 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_arcjet_status.md: -------------------------------------------------------------------------------- 1 | Show details about an Arcjet site setup 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly extensions arcjet status [name] [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for status 15 | -y, --yes Accept all confirmations 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly extensions arcjet](/docs/flyctl/extensions-arcjet/) - Provision and manage Arcjet 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_enveloop_destroy.md: -------------------------------------------------------------------------------- 1 | Permanently destroy an Enveloop project 2 | 3 | ## Usage 4 | ~~~ 5 | fly extensions enveloop destroy [name] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for destroy 14 | -y, --yes Accept all confirmations 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly extensions enveloop](/docs/flyctl/extensions-enveloop/) - Provision and manage Enveloop projects 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_enveloop_list.md: -------------------------------------------------------------------------------- 1 | List your Enveloop projects 2 | 3 | ## Usage 4 | ~~~ 5 | fly extensions enveloop list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for list 12 | -o, --org string The target Fly.io organization 13 | -y, --yes Accept all confirmations 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly extensions enveloop](/docs/flyctl/extensions-enveloop/) - Provision and manage Enveloop projects 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_kubernetes_destroy.md: -------------------------------------------------------------------------------- 1 | Permanently destroy a Kubernetes cluster 2 | 3 | ## Usage 4 | ~~~ 5 | fly extensions kubernetes destroy [name] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for destroy 12 | -y, --yes Accept all confirmations 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly extensions kubernetes](/docs/flyctl/extensions-kubernetes/) - Provision and manage Kubernetes clusters 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_kubernetes_list.md: -------------------------------------------------------------------------------- 1 | List your Kubernetes clusters 2 | 3 | ## Usage 4 | ~~~ 5 | fly extensions kubernetes list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for list 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly extensions kubernetes](/docs/flyctl/extensions-kubernetes/) - Provision and manage Kubernetes clusters 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_kubernetes_save-kubeconfig.md: -------------------------------------------------------------------------------- 1 | Save the kubeconfig file of your cluster 2 | 3 | ## Usage 4 | ~~~ 5 | fly extensions kubernetes save-kubeconfig [cluster name] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for save-kubeconfig 12 | --output string The output path to save the kubeconfig file 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly extensions kubernetes](/docs/flyctl/extensions-kubernetes/) - Provision and manage Kubernetes clusters 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_mysql_destroy.md: -------------------------------------------------------------------------------- 1 | Permanently destroy a MySQL database 2 | 3 | ## Usage 4 | ~~~ 5 | fly extensions mysql destroy [name] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for destroy 14 | -y, --yes Accept all confirmations 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL database clusters 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_mysql_list.md: -------------------------------------------------------------------------------- 1 | List your MySQL databases 2 | 3 | ## Usage 4 | ~~~ 5 | fly extensions mysql list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for list 12 | -o, --org string The target Fly.io organization 13 | -y, --yes Accept all confirmations 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL database clusters 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_mysql_status.md: -------------------------------------------------------------------------------- 1 | Show details about a MySQL database 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly extensions mysql status [name] [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for status 15 | -y, --yes Accept all confirmations 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL database clusters 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_sentry_create.md: -------------------------------------------------------------------------------- 1 | Provision a Sentry project for a Fly.io app 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly extensions sentry create [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for create 15 | -y, --yes Accept all confirmations 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly extensions sentry](/docs/flyctl/extensions-sentry/) - Setup a Sentry project for this app 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_sentry_dashboard.md: -------------------------------------------------------------------------------- 1 | View application errors in the Sentry dashboard 2 | 3 | ## Usage 4 | ~~~ 5 | fly extensions sentry dashboard [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for dashboard 14 | -y, --yes Accept all confirmations 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly extensions sentry](/docs/flyctl/extensions-sentry/) - Setup a Sentry project for this app 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_sentry_destroy.md: -------------------------------------------------------------------------------- 1 | Permanently destroy a Sentry project 2 | 3 | ## Usage 4 | ~~~ 5 | fly extensions sentry destroy [project-name] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for destroy 14 | -y, --yes Accept all confirmations 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly extensions sentry](/docs/flyctl/extensions-sentry/) - Setup a Sentry project for this app 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_sentry_list.md: -------------------------------------------------------------------------------- 1 | List your Sentry projects 2 | 3 | ## Usage 4 | ~~~ 5 | fly extensions sentry list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for list 12 | -o, --org string The target Fly.io organization 13 | -y, --yes Accept all confirmations 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly extensions sentry](/docs/flyctl/extensions-sentry/) - Setup a Sentry project for this app 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_storage_list.md: -------------------------------------------------------------------------------- 1 | List your Tigris object storage buckets 2 | 3 | ## Usage 4 | ~~~ 5 | fly extensions storage list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for list 12 | -o, --org string The target Fly.io organization 13 | -y, --yes Accept all confirmations 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly extensions storage](/docs/flyctl/extensions-storage/) - Provision and manage Tigris object storage buckets 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_supabase_list.md: -------------------------------------------------------------------------------- 1 | List your Supabase databases 2 | 3 | ## Usage 4 | ~~~ 5 | fly extensions supabase list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for list 12 | -o, --org string The target Fly.io organization 13 | -y, --yes Accept all confirmations 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly extensions supabase](/docs/flyctl/extensions-supabase/) - Provision and manage Supabase Postgres databases 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_extensions_vector_list.md: -------------------------------------------------------------------------------- 1 | List your Upstash Vector index 2 | 3 | ## Usage 4 | ~~~ 5 | fly extensions vector list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for list 12 | -o, --org string The target Fly.io organization 13 | -y, --yes Accept all confirmations 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly extensions vector](/docs/flyctl/extensions-vector/) - Provision and manage Upstash Vector index 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_image.md: -------------------------------------------------------------------------------- 1 | Manage app image 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly image [command] [flags] 7 | ~~~ 8 | 9 | ## Available Commands 10 | * [show](/docs/flyctl/image-show/) - Show image details. 11 | * [update](/docs/flyctl/image-update/) - Updates the app's image to the latest available version. 12 | 13 | ## Options 14 | 15 | ~~~ 16 | -h, --help help for image 17 | ~~~ 18 | 19 | ## Global Options 20 | 21 | ~~~ 22 | -t, --access-token string Fly API Access Token 23 | --debug Print additional logs and traces 24 | --verbose Verbose output 25 | ~~~ 26 | 27 | ## See Also 28 | 29 | * [fly](/docs/flyctl/help/) - The Fly.io command line interface 30 | 31 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_image_show.md: -------------------------------------------------------------------------------- 1 | Show image details. 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly image show [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for show 15 | -j, --json JSON output 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly image](/docs/flyctl/image/) - Manage app image 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_incidents.md: -------------------------------------------------------------------------------- 1 | Show incidents that may be affecting your organization. 2 | 3 | ## Usage 4 | ~~~ 5 | fly incidents [command] [flags] 6 | ~~~ 7 | 8 | ## Available Commands 9 | * [hosts](/docs/flyctl/incidents-hosts/) - Show hosts' incidents 10 | * [list](/docs/flyctl/incidents-list/) - List active incidents. 11 | 12 | ## Options 13 | 14 | ~~~ 15 | -h, --help help for incidents 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly](/docs/flyctl/help/) - The Fly.io command line interface 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_incidents_hosts.md: -------------------------------------------------------------------------------- 1 | Show hosts' incidents affecting applications 2 | 3 | ## Usage 4 | ~~~ 5 | fly incidents hosts [command] [flags] 6 | ~~~ 7 | 8 | ## Available Commands 9 | * [list](/docs/flyctl/incidents-hosts-list/) - List hosts' issues affecting the application 10 | 11 | ## Options 12 | 13 | ~~~ 14 | -h, --help help for hosts 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly incidents](/docs/flyctl/incidents/) - Show incidents 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_incidents_hosts_list.md: -------------------------------------------------------------------------------- 1 | List hosts' issues affecting the application 2 | 3 | ## Usage 4 | ~~~ 5 | fly incidents hosts list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for list 14 | -j, --json JSON output 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly incidents hosts](/docs/flyctl/incidents-hosts/) - Show hosts' incidents 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_ips_list.md: -------------------------------------------------------------------------------- 1 | Lists the IP addresses allocated to the application 2 | 3 | ## Usage 4 | ~~~ 5 | fly ips list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for list 14 | -j, --json JSON output 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly ips](/docs/flyctl/ips/) - Manage IP addresses for apps 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_ips_private.md: -------------------------------------------------------------------------------- 1 | List instances private IP addresses, accessible from within the Fly network 2 | 3 | ## Usage 4 | ~~~ 5 | fly ips private [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for private 14 | -j, --json JSON output 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly ips](/docs/flyctl/ips/) - Manage IP addresses for apps 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_ips_release.md: -------------------------------------------------------------------------------- 1 | Releases one or more IP addresses from the application 2 | 3 | ## Usage 4 | ~~~ 5 | fly ips release [flags] ADDRESS ADDRESS ... 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for release 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly ips](/docs/flyctl/ips/) - Manage IP addresses for apps 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_jobs.md: -------------------------------------------------------------------------------- 1 | Show jobs at Fly.io, including maybe ones you should apply to 2 | 3 | ## Usage 4 | ~~~ 5 | fly jobs [flags] 6 | ~~~ 7 | 8 | ## Available Commands 9 | * [open](/docs/flyctl/jobs-open/) - Open fly.io/jobs 10 | 11 | ## Options 12 | 13 | ~~~ 14 | -h, --help help for jobs 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly](/docs/flyctl/help/) - The Fly.io command line interface 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_jobs_open.md: -------------------------------------------------------------------------------- 1 | Open browser to https://fly.io/jobs/ 2 | 3 | ## Usage 4 | ~~~ 5 | fly jobs open [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for open 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly jobs](/docs/flyctl/jobs/) - Show jobs at Fly.io 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_litefs-cloud_clusters_destroy.md: -------------------------------------------------------------------------------- 1 | Permanently deletes a LiteFS Cloud cluster. 2 | 3 | ## Usage 4 | ~~~ 5 | fly litefs-cloud clusters destroy [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for destroy 12 | -j, --json JSON output 13 | -o, --org string The target Fly.io organization 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly litefs-cloud clusters](/docs/flyctl/litefs-cloud-clusters/) - Manage LiteFS Cloud clusters 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_litefs-cloud_regions.md: -------------------------------------------------------------------------------- 1 | View a list of LiteFS Cloud regions 2 | 3 | ## Usage 4 | ~~~ 5 | fly litefs-cloud regions [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for regions 12 | -j, --json JSON output 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly litefs-cloud](/docs/flyctl/litefs-cloud/) - LiteFS Cloud management commands 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_litefs-cloud_status.md: -------------------------------------------------------------------------------- 1 | Lists the databases in the cluster with their replication position. 2 | 3 | ## Usage 4 | ~~~ 5 | fly litefs-cloud status [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -c, --cluster string LiteFS Cloud cluster name 12 | -h, --help help for status 13 | -j, --json JSON output 14 | -o, --org string The target Fly.io organization 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly litefs-cloud](/docs/flyctl/litefs-cloud/) - LiteFS Cloud management commands 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_machine_api-proxy.md: -------------------------------------------------------------------------------- 1 | Establish a proxy to the Machine API through a Wireguard tunnel for local connections 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly machine api-proxy [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -h, --help help for api-proxy 13 | -o, --org string The target Fly.io organization 14 | -q, --quiet Don't print progress indicators for WireGuard 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly machine](/docs/flyctl/machine/) - Manage Fly Machines. 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_machine_cordon.md: -------------------------------------------------------------------------------- 1 | Deactivate all services on a machine 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly machine cordon [...] [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for cordon 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly machine](/docs/flyctl/machine/) - Manage Fly Machines. 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_machine_egress-ip_list.md: -------------------------------------------------------------------------------- 1 | List all allocated static egress IP addresses with their corresponding machine 2 | 3 | ## Usage 4 | ~~~ 5 | fly machine egress-ip list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for list 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly machine egress-ip](/docs/flyctl/machine-egress-ip/) - Manage static egress IPs 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_machine_egress-ip_release.md: -------------------------------------------------------------------------------- 1 | Release an egress IP address for a machine 2 | 3 | ## Usage 4 | ~~~ 5 | fly machine egress-ip release [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for release 14 | -y, --yes Accept all confirmations 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly machine egress-ip](/docs/flyctl/machine-egress-ip/) - Manage static egress IPs 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_machine_exec.md: -------------------------------------------------------------------------------- 1 | Execute a command on a machine 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly machine exec [machine-id] [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for exec 15 | -j, --json JSON output 16 | --timeout int Timeout in seconds 17 | ~~~ 18 | 19 | ## Global Options 20 | 21 | ~~~ 22 | -t, --access-token string Fly API Access Token 23 | --debug Print additional logs and traces 24 | --verbose Verbose output 25 | ~~~ 26 | 27 | ## See Also 28 | 29 | * [fly machine](/docs/flyctl/machine/) - Manage Fly Machines. 30 | 31 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_machine_kill.md: -------------------------------------------------------------------------------- 1 | Kill (SIGKILL) a Fly machine 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly machine kill [id] [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for kill 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly machine](/docs/flyctl/machine/) - Manage Fly Machines. 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_machine_leases.md: -------------------------------------------------------------------------------- 1 | Manage machine leases 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly machine leases [command] [flags] 7 | ~~~ 8 | 9 | ## Available Commands 10 | * [clear](/docs/flyctl/machine-leases-clear/) - Clear machine leases 11 | * [view](/docs/flyctl/machine-leases-view/) - View machine leases 12 | 13 | ## Options 14 | 15 | ~~~ 16 | -h, --help help for leases 17 | ~~~ 18 | 19 | ## Global Options 20 | 21 | ~~~ 22 | -t, --access-token string Fly API Access Token 23 | --debug Print additional logs and traces 24 | --verbose Verbose output 25 | ~~~ 26 | 27 | ## See Also 28 | 29 | * [fly machine](/docs/flyctl/machine/) - Manage Fly Machines. 30 | 31 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_machine_leases_clear.md: -------------------------------------------------------------------------------- 1 | Clear machine leases 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly machine leases clear [machine-id] [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for clear 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly machine leases](/docs/flyctl/machine-leases/) - Manage machine leases 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_machine_leases_view.md: -------------------------------------------------------------------------------- 1 | View machine leases 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly machine leases view [machine-id] [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for view 15 | -j, --json JSON output 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly machine leases](/docs/flyctl/machine-leases/) - Manage machine leases 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_machine_list.md: -------------------------------------------------------------------------------- 1 | List Fly machines 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly machine list [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for list 15 | -j, --json JSON output 16 | -q, --quiet Only list machine ids 17 | ~~~ 18 | 19 | ## Global Options 20 | 21 | ~~~ 22 | -t, --access-token string Fly API Access Token 23 | --debug Print additional logs and traces 24 | --verbose Verbose output 25 | ~~~ 26 | 27 | ## See Also 28 | 29 | * [fly machine](/docs/flyctl/machine/) - Manage Fly Machines. 30 | 31 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_machine_start.md: -------------------------------------------------------------------------------- 1 | Start one or more Fly machines 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly machine start [...] [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for start 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly machine](/docs/flyctl/machine/) - Manage Fly Machines. 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_machine_status.md: -------------------------------------------------------------------------------- 1 | Show current status of a running machine 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly machine status [id] [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -d, --display-config Display the machine config as JSON 15 | -h, --help help for status 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly machine](/docs/flyctl/machine/) - Manage Fly Machines. 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_machine_uncordon.md: -------------------------------------------------------------------------------- 1 | Reactivate all services on a machine 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly machine uncordon [...] [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for uncordon 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly machine](/docs/flyctl/machine/) - Manage Fly Machines. 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_managed-postgres_connect.md: -------------------------------------------------------------------------------- 1 | Connect to a MPG database using psql 2 | 3 | ## Usage 4 | ~~~ 5 | fly managed-postgres connect [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | --cluster string The target cluster ID 12 | -h, --help help for connect 13 | -o, --org string The target Fly.io organization 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly managed-postgres](/docs/flyctl/managed-postgres/) - Manage Managed Postgres clusters. 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_managed-postgres_list.md: -------------------------------------------------------------------------------- 1 | List MPG clusters owned by the specified organization. 2 | If no organization is specified, the user's personal organization is used. 3 | 4 | ## Usage 5 | ~~~ 6 | fly managed-postgres list [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -h, --help help for list 13 | -j, --json JSON output 14 | -o, --org string The target Fly.io organization 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly managed-postgres](/docs/flyctl/managed-postgres/) - Manage Managed Postgres clusters. 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_managed-postgres_status.md: -------------------------------------------------------------------------------- 1 | Show status and details of a specific Managed Postgres cluster using its ID. 2 | 3 | ## Usage 4 | ~~~ 5 | fly managed-postgres status [CLUSTER_ID] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for status 12 | -j, --json JSON output 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly managed-postgres](/docs/flyctl/managed-postgres/) - Manage Managed Postgres clusters. 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_mysql_destroy.md: -------------------------------------------------------------------------------- 1 | Permanently destroy a MySQL database 2 | 3 | ## Usage 4 | ~~~ 5 | fly mysql destroy [name] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for destroy 14 | -y, --yes Accept all confirmations 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly mysql](/docs/flyctl/mysql/) - Provision and manage MySQL database clusters 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_mysql_list.md: -------------------------------------------------------------------------------- 1 | List your MySQL databases 2 | 3 | ## Usage 4 | ~~~ 5 | fly mysql list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for list 12 | -o, --org string The target Fly.io organization 13 | -y, --yes Accept all confirmations 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly mysql](/docs/flyctl/mysql/) - Provision and manage MySQL database clusters 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_mysql_status.md: -------------------------------------------------------------------------------- 1 | Show details about a MySQL database 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly mysql status [name] [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for status 15 | -y, --yes Accept all confirmations 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly mysql](/docs/flyctl/mysql/) - Provision and manage MySQL database clusters 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_orgs_create.md: -------------------------------------------------------------------------------- 1 | Create a new organization. Other users can be invited to join the 2 | organization later. 3 | 4 | 5 | ## Usage 6 | ~~~ 7 | fly orgs create [name] [flags] 8 | ~~~ 9 | 10 | ## Options 11 | 12 | ~~~ 13 | -h, --help help for create 14 | -j, --json JSON output 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly orgs](/docs/flyctl/orgs/) - Commands for managing Fly organizations 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_orgs_delete.md: -------------------------------------------------------------------------------- 1 | Delete an existing organization. 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly orgs delete [-yes] [slug] [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -h, --help help for delete 13 | -y, --yes Accept all confirmations 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly orgs](/docs/flyctl/orgs/) - Commands for managing Fly organizations 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_orgs_invite.md: -------------------------------------------------------------------------------- 1 | Invite a user, by email, to join organization. The invitation will be 2 | sent, and the user will be pending until they respond. 3 | 4 | 5 | ## Usage 6 | ~~~ 7 | fly orgs invite [slug] [email] [flags] 8 | ~~~ 9 | 10 | ## Options 11 | 12 | ~~~ 13 | -h, --help help for invite 14 | -j, --json JSON output 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly orgs](/docs/flyctl/orgs/) - Commands for managing Fly organizations 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_orgs_list.md: -------------------------------------------------------------------------------- 1 | Lists organizations available to current user. 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly orgs list [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -h, --help help for list 13 | -j, --json JSON output 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly orgs](/docs/flyctl/orgs/) - Commands for managing Fly organizations 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_orgs_remove.md: -------------------------------------------------------------------------------- 1 | Remove a user from an organization. User must have accepted a previous 2 | invitation to join (if not, see orgs revoke). 3 | 4 | 5 | ## Usage 6 | ~~~ 7 | fly orgs remove [slug] [email] [flags] 8 | ~~~ 9 | 10 | ## Options 11 | 12 | ~~~ 13 | -h, --help help for remove 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly orgs](/docs/flyctl/orgs/) - Commands for managing Fly organizations 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_orgs_show.md: -------------------------------------------------------------------------------- 1 | Shows information about an organization. 2 | Includes name, slug and type. Summarizes user permissions, DNS zones and 3 | associated member. Details full list of members and roles. 4 | 5 | 6 | ## Usage 7 | ~~~ 8 | fly orgs show [slug] [flags] 9 | ~~~ 10 | 11 | ## Options 12 | 13 | ~~~ 14 | -h, --help help for show 15 | -j, --json JSON output 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly orgs](/docs/flyctl/orgs/) - Commands for managing Fly organizations 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_platform_regions.md: -------------------------------------------------------------------------------- 1 | View a list of regions where Fly has datacenters. 2 | 'Capacity' shows how many performance-1x VMs can currently be launched in each region. 3 | 4 | 5 | ## Usage 6 | ~~~ 7 | fly platform regions [flags] 8 | ~~~ 9 | 10 | ## Options 11 | 12 | ~~~ 13 | -h, --help help for regions 14 | -j, --json JSON output 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly platform](/docs/flyctl/platform/) - Fly platform information 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_platform_status.md: -------------------------------------------------------------------------------- 1 | Show current Fly platform status in a browser or via json with the json flag 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly platform status [kind] [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -h, --help help for status 13 | -j, --json JSON output 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly platform](/docs/flyctl/platform/) - Fly platform information 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_platform_vm-sizes.md: -------------------------------------------------------------------------------- 1 | View a list of VM sizes which can be used with the FLYCTL SCALE VM command 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly platform vm-sizes [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -h, --help help for vm-sizes 13 | -j, --json JSON output 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly platform](/docs/flyctl/platform/) - Fly platform information 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_postgres_backup_config.md: -------------------------------------------------------------------------------- 1 | Manage backup configuration 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly postgres backup config [command] [flags] 7 | ~~~ 8 | 9 | ## Available Commands 10 | * [show](/docs/flyctl/postgres-backup-config-show/) - Show backup configuration 11 | * [update](/docs/flyctl/postgres-backup-config-update/) - Update backup configuration 12 | 13 | ## Options 14 | 15 | ~~~ 16 | -h, --help help for config 17 | ~~~ 18 | 19 | ## Global Options 20 | 21 | ~~~ 22 | -t, --access-token string Fly API Access Token 23 | --debug Print additional logs and traces 24 | --verbose Verbose output 25 | ~~~ 26 | 27 | ## See Also 28 | 29 | * [fly postgres backup](/docs/flyctl/postgres-backup/) - Backup commands 30 | 31 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_postgres_backup_config_show.md: -------------------------------------------------------------------------------- 1 | Show backup configuration 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly postgres backup config show [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for show 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly postgres backup config](/docs/flyctl/postgres-backup-config/) - Manage backup configuration 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_postgres_backup_enable.md: -------------------------------------------------------------------------------- 1 | Enable backups on a Postgres cluster, creating a Tigris bucket for storage 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly postgres backup enable [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for enable 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly postgres backup](/docs/flyctl/postgres-backup/) - Backup commands 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_postgres_backup_list.md: -------------------------------------------------------------------------------- 1 | List backups 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly postgres backup list [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for list 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly postgres backup](/docs/flyctl/postgres-backup/) - Backup commands 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_postgres_config_show.md: -------------------------------------------------------------------------------- 1 | Show Postgres configuration 2 | 3 | ## Usage 4 | ~~~ 5 | fly postgres config show [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for show 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly postgres config](/docs/flyctl/postgres-config/) - Show and manage Postgres configuration. 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_postgres_db.md: -------------------------------------------------------------------------------- 1 | Manage databases in a cluster 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly postgres db [command] [flags] 7 | ~~~ 8 | 9 | ## Available Commands 10 | * [list](/docs/flyctl/postgres-db-list/) - list databases 11 | 12 | ## Options 13 | 14 | ~~~ 15 | -h, --help help for db 16 | -j, --json JSON output 17 | ~~~ 18 | 19 | ## Global Options 20 | 21 | ~~~ 22 | -t, --access-token string Fly API Access Token 23 | --debug Print additional logs and traces 24 | --verbose Verbose output 25 | ~~~ 26 | 27 | ## See Also 28 | 29 | * [fly postgres](/docs/flyctl/postgres/) - Deprecated: Unmanaged Postgres cluster commands' 30 | 31 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_postgres_db_list.md: -------------------------------------------------------------------------------- 1 | list databases 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly postgres db list [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for list 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly postgres db](/docs/flyctl/postgres-db/) - Manage databases in a cluster 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_postgres_detach.md: -------------------------------------------------------------------------------- 1 | Detach a postgres cluster from an app 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly postgres detach [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for detach 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly postgres](/docs/flyctl/postgres/) - Deprecated: Unmanaged Postgres cluster commands' 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_postgres_events.md: -------------------------------------------------------------------------------- 1 | Track major cluster events 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly postgres events [command] [flags] 7 | ~~~ 8 | 9 | ## Available Commands 10 | * [list](/docs/flyctl/postgres-events-list/) - Outputs a formatted list of cluster events 11 | 12 | ## Options 13 | 14 | ~~~ 15 | -h, --help help for events 16 | -j, --json JSON output 17 | ~~~ 18 | 19 | ## Global Options 20 | 21 | ~~~ 22 | -t, --access-token string Fly API Access Token 23 | --debug Print additional logs and traces 24 | --verbose Verbose output 25 | ~~~ 26 | 27 | ## See Also 28 | 29 | * [fly postgres](/docs/flyctl/postgres/) - Deprecated: Unmanaged Postgres cluster commands' 30 | 31 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_postgres_list.md: -------------------------------------------------------------------------------- 1 | List postgres clusters 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly postgres list [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -h, --help help for list 13 | -j, --json JSON output 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly postgres](/docs/flyctl/postgres/) - Deprecated: Unmanaged Postgres cluster commands' 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_postgres_users.md: -------------------------------------------------------------------------------- 1 | Manage users in a postgres cluster 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly postgres users [command] [flags] 7 | ~~~ 8 | 9 | ## Available Commands 10 | * [list](/docs/flyctl/postgres-users-list/) - List users 11 | 12 | ## Options 13 | 14 | ~~~ 15 | -h, --help help for users 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly postgres](/docs/flyctl/postgres/) - Deprecated: Unmanaged Postgres cluster commands' 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_postgres_users_list.md: -------------------------------------------------------------------------------- 1 | List users 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly postgres users list [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for list 15 | -j, --json JSON output 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly postgres users](/docs/flyctl/postgres-users/) - Manage users in a postgres cluster 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_redis_connect.md: -------------------------------------------------------------------------------- 1 | Connect to a Redis database using redis-cli 2 | 3 | ## Usage 4 | ~~~ 5 | fly redis connect [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for connect 12 | -o, --org string The target Fly.io organization 13 | -r, --region string The target region (see 'flyctl platform regions') 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly redis](/docs/flyctl/redis/) - Launch and manage Redis databases managed by Upstash.com 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_redis_dashboard.md: -------------------------------------------------------------------------------- 1 | View your Upstash Redis databases on the Upstash web console 2 | 3 | ## Usage 4 | ~~~ 5 | fly redis dashboard [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for dashboard 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly redis](/docs/flyctl/redis/) - Launch and manage Redis databases managed by Upstash.com 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_redis_destroy.md: -------------------------------------------------------------------------------- 1 | Permanently destroy an Upstash Redis database 2 | 3 | ## Usage 4 | ~~~ 5 | fly redis destroy [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for destroy 12 | -y, --yes Accept all confirmations 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly redis](/docs/flyctl/redis/) - Launch and manage Redis databases managed by Upstash.com 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_redis_list.md: -------------------------------------------------------------------------------- 1 | List Upstash Redis databases for an organization 2 | 3 | ## Usage 4 | ~~~ 5 | fly redis list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for list 12 | -o, --org string The target Fly.io organization 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly redis](/docs/flyctl/redis/) - Launch and manage Redis databases managed by Upstash.com 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_redis_plans.md: -------------------------------------------------------------------------------- 1 | List available Redis plans 2 | 3 | ## Usage 4 | ~~~ 5 | fly redis plans [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for plans 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly redis](/docs/flyctl/redis/) - Launch and manage Redis databases managed by Upstash.com 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_redis_proxy.md: -------------------------------------------------------------------------------- 1 | Proxy to a Redis database 2 | 3 | ## Usage 4 | ~~~ 5 | fly redis proxy [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for proxy 12 | -o, --org string The target Fly.io organization 13 | -r, --region string The target region (see 'flyctl platform regions') 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly redis](/docs/flyctl/redis/) - Launch and manage Redis databases managed by Upstash.com 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_redis_reset.md: -------------------------------------------------------------------------------- 1 | Reset the password for an Upstash Redis database 2 | 3 | ## Usage 4 | ~~~ 5 | fly redis reset [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for reset 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly redis](/docs/flyctl/redis/) - Launch and manage Redis databases managed by Upstash.com 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_redis_status.md: -------------------------------------------------------------------------------- 1 | Show status of a Redis database 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly redis status [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -h, --help help for status 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly redis](/docs/flyctl/redis/) - Launch and manage Redis databases managed by Upstash.com 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_scale_memory.md: -------------------------------------------------------------------------------- 1 | Set VM memory to a number of megabytes 2 | 3 | ## Usage 4 | ~~~ 5 | fly scale memory [memoryMB] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for memory 14 | -g, --process-group string The process group to apply the VM size to 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly scale](/docs/flyctl/scale/) - Scale app resources 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_scale_show.md: -------------------------------------------------------------------------------- 1 | Show current VM size and counts 2 | 3 | ## Usage 4 | ~~~ 5 | fly scale show [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for show 14 | -j, --json JSON output 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly scale](/docs/flyctl/scale/) - Scale app resources 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_services.md: -------------------------------------------------------------------------------- 1 | Shows information about the services of the application. 2 | 3 | ## Usage 4 | ~~~ 5 | fly services [command] [flags] 6 | ~~~ 7 | 8 | ## Available Commands 9 | * [list](/docs/flyctl/services-list/) - List services 10 | 11 | ## Options 12 | 13 | ~~~ 14 | -h, --help help for services 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly](/docs/flyctl/help/) - The Fly.io command line interface 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_services_list.md: -------------------------------------------------------------------------------- 1 | List the services that are associated with an app 2 | 3 | ## Usage 4 | ~~~ 5 | fly services list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for list 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly services](/docs/flyctl/services/) - Show the application's services 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_settings_analytics.md: -------------------------------------------------------------------------------- 1 | Control anonymized analytics collection 2 | 3 | ## Usage 4 | ~~~ 5 | fly settings analytics [flags] 6 | ~~~ 7 | 8 | ## Available Commands 9 | * [disable](/docs/flyctl/settings-analytics-disable/) - Disable analytics 10 | * [enable](/docs/flyctl/settings-analytics-enable/) - Enable analytics 11 | 12 | ## Options 13 | 14 | ~~~ 15 | -h, --help help for analytics 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly settings](/docs/flyctl/settings/) - Manage flyctl settings 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_settings_analytics_disable.md: -------------------------------------------------------------------------------- 1 | Disable analytics 2 | 3 | ## Usage 4 | ~~~ 5 | fly settings analytics disable [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for disable 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly settings analytics](/docs/flyctl/settings-analytics/) - Control anonymized analytics collection 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_settings_analytics_enable.md: -------------------------------------------------------------------------------- 1 | Enable analytics 2 | 3 | ## Usage 4 | ~~~ 5 | fly settings analytics enable [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for enable 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly settings analytics](/docs/flyctl/settings-analytics/) - Control anonymized analytics collection 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_settings_autoupdate.md: -------------------------------------------------------------------------------- 1 | Control automatic updates 2 | 3 | ## Usage 4 | ~~~ 5 | fly settings autoupdate [flags] 6 | ~~~ 7 | 8 | ## Available Commands 9 | * [disable](/docs/flyctl/settings-autoupdate-disable/) - Disable automatic updates 10 | * [enable](/docs/flyctl/settings-autoupdate-enable/) - Enable automatic updates 11 | 12 | ## Options 13 | 14 | ~~~ 15 | -h, --help help for autoupdate 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly settings](/docs/flyctl/settings/) - Manage flyctl settings 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_settings_autoupdate_disable.md: -------------------------------------------------------------------------------- 1 | Disable automatic updates 2 | 3 | ## Usage 4 | ~~~ 5 | fly settings autoupdate disable [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for disable 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly settings autoupdate](/docs/flyctl/settings-autoupdate/) - Control automatic updates 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_settings_autoupdate_enable.md: -------------------------------------------------------------------------------- 1 | Enable automatic updates 2 | 3 | ## Usage 4 | ~~~ 5 | fly settings autoupdate enable [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for enable 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly settings autoupdate](/docs/flyctl/settings-autoupdate/) - Control automatic updates 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_settings_synthetics.md: -------------------------------------------------------------------------------- 1 | Control synthetics agent execution 2 | 3 | ## Usage 4 | ~~~ 5 | fly settings synthetics [flags] 6 | ~~~ 7 | 8 | ## Available Commands 9 | * [disable](/docs/flyctl/settings-synthetics-disable/) - Disable synthetics 10 | * [enable](/docs/flyctl/settings-synthetics-enable/) - Enable synthetics 11 | 12 | ## Options 13 | 14 | ~~~ 15 | -h, --help help for synthetics 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly settings](/docs/flyctl/settings/) - Manage flyctl settings 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_settings_synthetics_disable.md: -------------------------------------------------------------------------------- 1 | Disable synthetics 2 | 3 | ## Usage 4 | ~~~ 5 | fly settings synthetics disable [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for disable 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly settings synthetics](/docs/flyctl/settings-synthetics/) - Control synthetics agent execution 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_settings_synthetics_enable.md: -------------------------------------------------------------------------------- 1 | Enable synthetics 2 | 3 | ## Usage 4 | ~~~ 5 | fly settings synthetics enable [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for enable 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly settings synthetics](/docs/flyctl/settings-synthetics/) - Control synthetics agent execution 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_ssh_log.md: -------------------------------------------------------------------------------- 1 | Log of all issued SSH certs 2 | 3 | ## Usage 4 | ~~~ 5 | fly ssh log [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for log 12 | -j, --json JSON output 13 | -o, --org string The target Fly.io organization 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly ssh](/docs/flyctl/ssh/) - Use SSH to log into or run commands on Machines 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_storage_destroy.md: -------------------------------------------------------------------------------- 1 | Permanently destroy a Tigris object storage bucket 2 | 3 | ## Usage 4 | ~~~ 5 | fly storage destroy [storage-bucket-name] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for destroy 14 | -y, --yes Accept all confirmations 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly storage](/docs/flyctl/storage/) - Provision and manage Tigris object storage buckets 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_storage_list.md: -------------------------------------------------------------------------------- 1 | List your Tigris object storage buckets 2 | 3 | ## Usage 4 | ~~~ 5 | fly storage list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for list 12 | -o, --org string The target Fly.io organization 13 | -y, --yes Accept all confirmations 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly storage](/docs/flyctl/storage/) - Provision and manage Tigris object storage buckets 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_storage_status.md: -------------------------------------------------------------------------------- 1 | Show details about a Tigris storage bucket 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly storage status [name] [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for status 15 | -y, --yes Accept all confirmations 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly storage](/docs/flyctl/storage/) - Provision and manage Tigris object storage buckets 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_synthetics.md: -------------------------------------------------------------------------------- 1 | Synthetic monitoring management. 2 | 3 | ## Usage 4 | ~~~ 5 | fly synthetics [command] [flags] 6 | ~~~ 7 | 8 | ## Available Commands 9 | * [agent](/docs/flyctl/synthetics-agent/) - Runs the Synthetics agent 10 | 11 | ## Options 12 | 13 | ~~~ 14 | -h, --help help for synthetics 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly](/docs/flyctl/help/) - The Fly.io command line interface 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_synthetics_agent.md: -------------------------------------------------------------------------------- 1 | Runs the Synthetics agent in the foreground. 2 | 3 | ## Usage 4 | ~~~ 5 | fly synthetics agent [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for agent 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly synthetics](/docs/flyctl/synthetics/) - Synthetic monitoring 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_tokens_list.md: -------------------------------------------------------------------------------- 1 | List tokens 2 | 3 | ## Usage 4 | ~~~ 5 | fly tokens list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for list 14 | -o, --org string The target Fly.io organization 15 | -s, --scope string either 'app' or 'org' 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly tokens](/docs/flyctl/tokens/) - Manage Fly.io API tokens 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_tokens_revoke.md: -------------------------------------------------------------------------------- 1 | Revoke one or more tokens. 2 | 3 | ## Usage 4 | ~~~ 5 | fly tokens revoke [flags] ID ID ... 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for revoke 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly tokens](/docs/flyctl/tokens/) - Manage Fly.io API tokens 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_version.md: -------------------------------------------------------------------------------- 1 | Shows version information for the flyctl command itself, including version 2 | number and build date. 3 | 4 | ## Usage 5 | ~~~ 6 | fly version [flags] 7 | ~~~ 8 | 9 | ## Available Commands 10 | * [upgrade](/docs/flyctl/version-upgrade/) - Checks for available updates and automatically upgrades 11 | 12 | ## Options 13 | 14 | ~~~ 15 | -h, --help help for version 16 | -j, --json JSON output 17 | ~~~ 18 | 19 | ## Global Options 20 | 21 | ~~~ 22 | -t, --access-token string Fly API Access Token 23 | --debug Print additional logs and traces 24 | --verbose Verbose output 25 | ~~~ 26 | 27 | ## See Also 28 | 29 | * [fly](/docs/flyctl/help/) - The Fly.io command line interface 30 | 31 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_version_upgrade.md: -------------------------------------------------------------------------------- 1 | Checks for an update and if one is available, runs the appropriate 2 | command to upgrade the application. 3 | 4 | ## Usage 5 | ~~~ 6 | fly version upgrade [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -h, --help help for upgrade 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly version](/docs/flyctl/version/) - Show version information for the flyctl command 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_volumes_destroy.md: -------------------------------------------------------------------------------- 1 | Destroy one or more volumes. When you destroy a volume, you permanently delete all its data. 2 | 3 | ## Usage 4 | ~~~ 5 | fly volumes destroy ... [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for destroy 14 | -y, --yes Accept all confirmations 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly volumes](/docs/flyctl/volumes/) - Manage Fly Volumes. 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_volumes_list.md: -------------------------------------------------------------------------------- 1 | List the volumes associated with an app. 2 | 3 | ## Usage 4 | ~~~ 5 | fly volumes list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | --all Show all volumes including those in destroyed states 12 | -a, --app string Application name 13 | -c, --config string Path to application configuration file 14 | -h, --help help for list 15 | -j, --json JSON output 16 | ~~~ 17 | 18 | ## Global Options 19 | 20 | ~~~ 21 | -t, --access-token string Fly API Access Token 22 | --debug Print additional logs and traces 23 | --verbose Verbose output 24 | ~~~ 25 | 26 | ## See Also 27 | 28 | * [fly volumes](/docs/flyctl/volumes/) - Manage Fly Volumes. 29 | 30 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_volumes_show.md: -------------------------------------------------------------------------------- 1 | Show the details of the specified volume. 2 | 3 | ## Usage 4 | ~~~ 5 | fly volumes show [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -a, --app string Application name 12 | -c, --config string Path to application configuration file 13 | -h, --help help for show 14 | -j, --json JSON output 15 | ~~~ 16 | 17 | ## Global Options 18 | 19 | ~~~ 20 | -t, --access-token string Fly API Access Token 21 | --debug Print additional logs and traces 22 | --verbose Verbose output 23 | ~~~ 24 | 25 | ## See Also 26 | 27 | * [fly volumes](/docs/flyctl/volumes/) - Manage Fly Volumes. 28 | 29 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_volumes_snapshots_create.md: -------------------------------------------------------------------------------- 1 | Snapshot a volume 2 | 3 | 4 | ## Usage 5 | ~~~ 6 | fly volumes snapshots create [flags] 7 | ~~~ 8 | 9 | ## Options 10 | 11 | ~~~ 12 | -h, --help help for create 13 | -j, --json JSON output 14 | ~~~ 15 | 16 | ## Global Options 17 | 18 | ~~~ 19 | -t, --access-token string Fly API Access Token 20 | --debug Print additional logs and traces 21 | --verbose Verbose output 22 | ~~~ 23 | 24 | ## See Also 25 | 26 | * [fly volumes snapshots](/docs/flyctl/volumes-snapshots/) - Manage volume snapshots. 27 | 28 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_volumes_snapshots_list.md: -------------------------------------------------------------------------------- 1 | List snapshots associated with the specified volume. 2 | 3 | ## Usage 4 | ~~~ 5 | fly volumes snapshots list [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for list 12 | -j, --json JSON output 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly volumes snapshots](/docs/flyctl/volumes-snapshots/) - Manage volume snapshots. 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_wireguard_create.md: -------------------------------------------------------------------------------- 1 | Add a WireGuard peer connection to an organization 2 | 3 | ## Usage 4 | ~~~ 5 | fly wireguard create [org] [region] [name] [file] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for create 12 | --network string Custom network name 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly wireguard](/docs/flyctl/wireguard/) - Commands that manage WireGuard peer connections 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_wireguard_list.md: -------------------------------------------------------------------------------- 1 | List all WireGuard peer connections 2 | 3 | ## Usage 4 | ~~~ 5 | fly wireguard list [org] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for list 12 | -j, --json JSON output 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly wireguard](/docs/flyctl/wireguard/) - Commands that manage WireGuard peer connections 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_wireguard_remove.md: -------------------------------------------------------------------------------- 1 | Remove a WireGuard peer connection from an organization 2 | 3 | ## Usage 4 | ~~~ 5 | fly wireguard remove [org] [name] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for remove 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly wireguard](/docs/flyctl/wireguard/) - Commands that manage WireGuard peer connections 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_wireguard_reset.md: -------------------------------------------------------------------------------- 1 | Reset WireGuard peer connection for an organization 2 | 3 | ## Usage 4 | ~~~ 5 | fly wireguard reset [org] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for reset 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly wireguard](/docs/flyctl/wireguard/) - Commands that manage WireGuard peer connections 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_wireguard_token_create.md: -------------------------------------------------------------------------------- 1 | Create a new WireGuard token 2 | 3 | ## Usage 4 | ~~~ 5 | fly wireguard token create [org] [name] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for create 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly wireguard token](/docs/flyctl/wireguard-token/) - Commands that managed WireGuard delegated access tokens 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_wireguard_token_delete.md: -------------------------------------------------------------------------------- 1 | Delete a WireGuard token; token is name: or token: 2 | 3 | ## Usage 4 | ~~~ 5 | fly wireguard token delete [org] [token] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for delete 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly wireguard token](/docs/flyctl/wireguard-token/) - Commands that managed WireGuard delegated access tokens 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_wireguard_token_list.md: -------------------------------------------------------------------------------- 1 | List all WireGuard tokens 2 | 3 | ## Usage 4 | ~~~ 5 | fly wireguard token list [org] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for list 12 | -j, --json JSON output 13 | ~~~ 14 | 15 | ## Global Options 16 | 17 | ~~~ 18 | -t, --access-token string Fly API Access Token 19 | --debug Print additional logs and traces 20 | --verbose Verbose output 21 | ~~~ 22 | 23 | ## See Also 24 | 25 | * [fly wireguard token](/docs/flyctl/wireguard-token/) - Commands that managed WireGuard delegated access tokens 26 | 27 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_wireguard_token_start.md: -------------------------------------------------------------------------------- 1 | Start a new WireGuard peer connection associated with a token (set FLY_WIREGUARD_TOKEN) 2 | 3 | ## Usage 4 | ~~~ 5 | fly wireguard token start [name] [group] [region] [file] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for start 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly wireguard token](/docs/flyctl/wireguard-token/) - Commands that managed WireGuard delegated access tokens 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_wireguard_token_update.md: -------------------------------------------------------------------------------- 1 | Rekey a WireGuard peer connection associated with a token (set FLY_WIREGUARD_TOKEN) 2 | 3 | ## Usage 4 | ~~~ 5 | fly wireguard token update [name] [file] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for update 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly wireguard token](/docs/flyctl/wireguard-token/) - Commands that managed WireGuard delegated access tokens 25 | 26 | -------------------------------------------------------------------------------- /flyctl/cmd/fly_wireguard_websockets.md: -------------------------------------------------------------------------------- 1 | Enable or disable WireGuard tunneling over WebSockets 2 | 3 | ## Usage 4 | ~~~ 5 | fly wireguard websockets [enable|disable] [flags] 6 | ~~~ 7 | 8 | ## Options 9 | 10 | ~~~ 11 | -h, --help help for websockets 12 | ~~~ 13 | 14 | ## Global Options 15 | 16 | ~~~ 17 | -t, --access-token string Fly API Access Token 18 | --debug Print additional logs and traces 19 | --verbose Verbose output 20 | ~~~ 21 | 22 | ## See Also 23 | 24 | * [fly wireguard](/docs/flyctl/wireguard/) - Commands that manage WireGuard peer connections 25 | 26 | -------------------------------------------------------------------------------- /flyctl/install.html.markerb: -------------------------------------------------------------------------------- 1 | --- 2 | title: Install flyctl 3 | layout: docs 4 | nav: flyctl 5 | redirect_from: 6 | - /docs/getting-started/installing-flyctl/ 7 | - /docs/flyctl/installing/ 8 | - /docs/hands-on/installing/ 9 | - /docs/hands-on/install-flyctl/ 10 | --- 11 | 12 | <%= partial "/docs/partials/docs/flyctl_install" %> 13 | 14 | ### Next steps 15 | 16 | - [Launch an app](/docs/getting-started/launch/) 17 | - [Browse what's possible on Fly.io](/docs/blueprints/) 18 | -------------------------------------------------------------------------------- /getting-started/sign-up-sign-in.html.markerb: -------------------------------------------------------------------------------- 1 | --- 2 | title: Sign up and sign in to Fly.io 3 | layout: docs 4 | sitemap: false 5 | nav: firecracker 6 | toc: false 7 | redirect_from: 8 | - /docs/hands-on/sign-up/ 9 | - /docs/hands-on/sign-in/ 10 | - /docs/getting-started/log-in-to-fly/ 11 | - /docs/hands-on/sign-up-sign-in/ 12 | --- 13 | 14 | ## No account? Sign up for Fly.io 15 | 16 | <%= partial "/docs/partials/sign_up" %> 17 | 18 | ## Already have a Fly.io account? Sign in 19 | 20 | <%= partial "/docs/partials/sign_in" %> 21 | -------------------------------------------------------------------------------- /guides.html.markerb: -------------------------------------------------------------------------------- 1 | --- 2 | title: Guides and Examples 3 | layout: docs 4 | toc: false 5 | nav: firecracker 6 | --- 7 | 8 | A collection of guides and examples for working with Fly.io. 9 | 10 | - <%= nav_link "Going to production", "/docs/going-to-production/" %> 11 | - <%= nav_link "Crontab with Supercronic", "/docs/app-guides/supercronic/" %> 12 | - <%= nav_link "Run an ssh server ", "/docs/app-guides/opensshd/" %> 13 | -------------------------------------------------------------------------------- /images/Managed_Postgres.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/Managed_Postgres.png -------------------------------------------------------------------------------- /images/backends-listing-screenshot.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/backends-listing-screenshot.webp -------------------------------------------------------------------------------- /images/channeling2.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/channeling2.webp -------------------------------------------------------------------------------- /images/cluster-from-home-to-fly-app-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/cluster-from-home-to-fly-app-1.png -------------------------------------------------------------------------------- /images/cluster-from-home-to-fly-app-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/cluster-from-home-to-fly-app-2.png -------------------------------------------------------------------------------- /images/configure.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/configure.webp -------------------------------------------------------------------------------- /images/configured.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/configured.webp -------------------------------------------------------------------------------- /images/cpu-quota.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/cpu-quota.png -------------------------------------------------------------------------------- /images/cpu-quota.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/cpu-quota.webp -------------------------------------------------------------------------------- /images/dns-verified.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/dns-verified.webp -------------------------------------------------------------------------------- /images/elixir-livebook-to-server-fly-overview.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/elixir-livebook-to-server-fly-overview.webp -------------------------------------------------------------------------------- /images/elixir-wireguard-observer-tunnel.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/elixir-wireguard-observer-tunnel.webp -------------------------------------------------------------------------------- /images/enable.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/enable.webp -------------------------------------------------------------------------------- /images/fauna_region_groups.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/fauna_region_groups.png -------------------------------------------------------------------------------- /images/fly-region-map.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/fly-region-map.webp -------------------------------------------------------------------------------- /images/flyhostname.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/flyhostname.webp -------------------------------------------------------------------------------- /images/laravel-app-ssr-vms.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/laravel-app-ssr-vms.png -------------------------------------------------------------------------------- /images/livebook-data-analysis-runtime-click-step1.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/livebook-data-analysis-runtime-click-step1.webp -------------------------------------------------------------------------------- /images/livebook-data-analysis-runtime-click-step2.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/livebook-data-analysis-runtime-click-step2.webp -------------------------------------------------------------------------------- /images/livebook-data-analysis-runtime-click-step3.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/livebook-data-analysis-runtime-click-step3.webp -------------------------------------------------------------------------------- /images/livebook-personality-bar-visualization.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/livebook-personality-bar-visualization.webp -------------------------------------------------------------------------------- /images/livebook-personality-pie-visualization.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/livebook-personality-pie-visualization.webp -------------------------------------------------------------------------------- /images/livebook-runtime-attach-steps.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/livebook-runtime-attach-steps.webp -------------------------------------------------------------------------------- /images/livebook-runtime-link.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/livebook-runtime-link.webp -------------------------------------------------------------------------------- /images/livebook-vegalite-examples.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/livebook-vegalite-examples.webp -------------------------------------------------------------------------------- /images/mcp-proxy-wrap-flog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/mcp-proxy-wrap-flog.png -------------------------------------------------------------------------------- /images/mermaid-diagram-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/mermaid-diagram-1.png -------------------------------------------------------------------------------- /images/mermaid-diagram-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/mermaid-diagram-2.png -------------------------------------------------------------------------------- /images/middleware.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/middleware.webp -------------------------------------------------------------------------------- /images/observer-local-node-connected.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/observer-local-node-connected.webp -------------------------------------------------------------------------------- /images/observer-local-node-menu.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/observer-local-node-menu.webp -------------------------------------------------------------------------------- /images/observer-local-node.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/observer-local-node.webp -------------------------------------------------------------------------------- /images/observer-tictac-local-application-pane.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/observer-tictac-local-application-pane.webp -------------------------------------------------------------------------------- /images/orgtoken.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/orgtoken.png -------------------------------------------------------------------------------- /images/planetscale_add_region.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/planetscale_add_region.webp -------------------------------------------------------------------------------- /images/planetscale_add_region_connect.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/planetscale_add_region_connect.webp -------------------------------------------------------------------------------- /images/planetscale_add_region_dialog.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/planetscale_add_region_dialog.webp -------------------------------------------------------------------------------- /images/planetscale_arctype_connection_url.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/planetscale_arctype_connection_url.webp -------------------------------------------------------------------------------- /images/planetscale_arctype_connections.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/planetscale_arctype_connections.webp -------------------------------------------------------------------------------- /images/planetscale_arctype_create_table_succeeded.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/planetscale_arctype_create_table_succeeded.webp -------------------------------------------------------------------------------- /images/planetscale_arctype_new_query.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/planetscale_arctype_new_query.webp -------------------------------------------------------------------------------- /images/planetscale_connect_nodejs.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/planetscale_connect_nodejs.webp -------------------------------------------------------------------------------- /images/planetscale_database_created.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/planetscale_database_created.webp -------------------------------------------------------------------------------- /images/planetscale_laravel_connection_string.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/planetscale_laravel_connection_string.webp -------------------------------------------------------------------------------- /images/planetscale_laravel_new_database.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/planetscale_laravel_new_database.webp -------------------------------------------------------------------------------- /images/planetscale_laravel_new_db_dialog.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/planetscale_laravel_new_db_dialog.webp -------------------------------------------------------------------------------- /images/planetscale_misc_delete.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/planetscale_misc_delete.webp -------------------------------------------------------------------------------- /images/planetscale_misc_statistics.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/planetscale_misc_statistics.webp -------------------------------------------------------------------------------- /images/planetscale_new_database_dialog.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/planetscale_new_database_dialog.webp -------------------------------------------------------------------------------- /images/planetscale_promote.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/planetscale_promote.webp -------------------------------------------------------------------------------- /images/routes.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/routes.webp -------------------------------------------------------------------------------- /images/sentient_balloon.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/sentient_balloon.webp -------------------------------------------------------------------------------- /images/slack-invite-add-rule.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/slack-invite-add-rule.webp -------------------------------------------------------------------------------- /images/slack-invite-backends.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/slack-invite-backends.webp -------------------------------------------------------------------------------- /images/slack-invite-final.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/slack-invite-final.webp -------------------------------------------------------------------------------- /images/slack-invite-hostnames.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/slack-invite-hostnames.webp -------------------------------------------------------------------------------- /images/slack-invite-rules.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/slack-invite-rules.webp -------------------------------------------------------------------------------- /images/tigris-launch-ui.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/tigris-launch-ui.png -------------------------------------------------------------------------------- /images/wormhole.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/images/wormhole.webp -------------------------------------------------------------------------------- /js/frameworks/partials/_flyctl.html.erb: -------------------------------------------------------------------------------- 1 | First, [install flyctl](/docs/flyctl/install/), the Fly.io CLI, and [sign up to Fly.io](/docs/getting-started/sign-up-sign-in/#first-time-or-no-fly-account-sign-up-for-fly) if you haven't already. 2 | -------------------------------------------------------------------------------- /js/frameworks/partials/_intro.html.erb: -------------------------------------------------------------------------------- 1 | Getting an application running on Fly.io is essentially working out how to package it as a deployable image<%- if defined?(database) %> and attach it to a database<%- end %>. 2 | Once packaged it can be deployed to the Fly.io platform. 3 | 4 | In this guide we'll learn how to deploy <%= "#{runtime.downcase.match(/^[aeiou]/) ? "an" : "a"} #{defined?(link) ? "[#{runtime}](#{link})" : "#{runtime}"}" %> 5 | <%= locals.key?(:type) ? type : "application" %> 6 | on Fly.io<%- if locals.key?(:database) %> and connect it to a PostgreSQL database<%- end %>. 7 | -------------------------------------------------------------------------------- /js/frameworks/partials/_launch.html.erb: -------------------------------------------------------------------------------- 1 | ```cmd 2 | cd <%= app_name %> 3 | fly launch 4 | ``` 5 | ```output 6 | Creating app in /Users/me/<%= app_name %> 7 | Scanning source code 8 | Detected a <%= detected %> app 9 | ? App Name (leave blank to use an auto-generated name): <%= app_name %> 10 | ? Select organization: flyio (flyio) 11 | ? Select region: mad (Madrid, Spain) 12 | Created app <%= app_name %> in organization soupedup 13 | ? Would you like to deploy now? Yes 14 | ==> Validating app configuration 15 | --> Validating app configuration done 16 | Services 17 | TCP 80/443 ⇢ 8080 18 | Remote builder fly-builder-little-glitter-8329 ready 19 | ... 20 | 1 desired, 1 placed, 1 healthy, 0 unhealthy [health checks: 2 total, 2 passing] 21 | --> v0 deployed successfully 22 | ``` 23 | -------------------------------------------------------------------------------- /js/frameworks/partials/_launched.html.erb: -------------------------------------------------------------------------------- 1 | That's it! Run `fly apps open` to see your deployed app in action. 2 | 3 | Try a few other commands: 4 | 5 | * [`fly logs`](/docs/flyctl/logs/) - Tail your application logs 6 | * [`fly status`](/docs/flyctl/status/) - View your app's current deployment status 7 | * [`fly ssh console`](/docs/flyctl/ssh-console/) - Open a terminal on your VM 8 | * [`fly deploy`](/docs/flyctl/deploy/) - Deploy the application after making changes 9 | -------------------------------------------------------------------------------- /languages-and-frameworks/partials/_flyctl.html.erb: -------------------------------------------------------------------------------- 1 | First, [install flyctl](/docs/flyctl/install/), the Fly.io CLI, and [sign up to Fly.io](/docs/getting-started/sign-up-sign-in/#first-time-or-no-fly-account-sign-up-for-fly) if you haven't already. 2 | -------------------------------------------------------------------------------- /languages-and-frameworks/partials/_install_flyctl_login.html.erb: -------------------------------------------------------------------------------- 1 | ## _Install Flyctl and Login_ 2 | 3 | It's time to install `flyctl`, the CLI app for managing apps on Fly.io. If you've already installed it, carry on. If not, hop over to [our installation guide](/docs/flyctl/install/). Once that's installed you'll want to [log in to Fly.io](/docs/getting-started/sign-up-sign-in/). 4 | -------------------------------------------------------------------------------- /languages-and-frameworks/partials/_intro.html.erb: -------------------------------------------------------------------------------- 1 | Getting an application running on Fly.io is essentially working out how to package it as a deployable image<%- if defined?(database) %> and attach it to a database<%- end %>. 2 | Once packaged, it can be deployed to the Fly.io platform. 3 | 4 | In this guide we'll learn how to deploy <%= "#{runtime.downcase.match(/^[aeiou]/) ? "an" : "a"} #{defined?(link) ? "[#{runtime}](#{link})" : "#{runtime}"}" %> 5 | <%= locals.key?(:type) ? type : "application" %> 6 | on Fly.io<%- if locals.key?(:database) %> and connect it to a PostgreSQL database<%- end %>. 7 | -------------------------------------------------------------------------------- /languages-and-frameworks/partials/_launched.html.erb: -------------------------------------------------------------------------------- 1 | That's it! Run `fly apps open` to see your deployed app in action. 2 | 3 | Try a few other commands: 4 | 5 | * [`fly logs`](/docs/flyctl/logs/) - Tail your application logs 6 | * [`fly status`](/docs/flyctl/status/) - View your app's current deployment status 7 | * [`fly ssh console`](/docs/flyctl/ssh-console/) - Open a terminal on your VM 8 | * [`fly deploy`](/docs/flyctl/deploy/) - Deploy the application after making changes 9 | -------------------------------------------------------------------------------- /laravel/advanced-guides.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Advanced guides 3 | layout: framework_docs_overview 4 | toc: false 5 | order: 3 6 | --- 7 | 8 | As your Laravel application becomes more popular, it will inevitably grow in complexity, the number of people using it will increase, and pretty much everything else goes up and to the right. Fortunately Fly can reduce some of that complexity by making global deployments easy and provide some best practices for scaling a Laravel application on Fly. -------------------------------------------------------------------------------- /laravel/database-guides.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Database guides 3 | layout: framework_docs_overview 4 | toc: false 5 | order: 3 6 | --- 7 | 8 | No application is complete without a data store! 9 | 10 | In this section, you'll find references on how to connect your Laravel application to Databases running as Fly Apps or as managed solutions from services that suits global distribution of data. 11 | 12 | Lastly, you can check the last section, "Laravel Database Migration" for a guide on how to run the classic Laravel command, "php artisan migrate", in Fly.io. 13 | 14 | -------------------------------------------------------------------------------- /laravel/the-basics.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: The Basics 3 | layout: framework_docs_overview 4 | toc: false 5 | order: 2 6 | --- 7 | 8 | Most Laravel applications require additional setup, including provisioning a database and cache. These guides will help you get through the basics of setting up your Laravel application with pieces of infrastructure commonly found in medium-to-high complexity applications. -------------------------------------------------------------------------------- /litefs/releases.html.markerb: -------------------------------------------------------------------------------- 1 | --- 2 | title: LiteFS Releases 3 | layout: docs 4 | nav: litefs 5 | toc: true 6 | --- 7 | 8 | If you're running on a Linux VPS without Docker, or as an alternative to installing 9 | from LiteFS Docker builds, you can download the latest 10 | version from our [LiteFS releases page](https://github.com/superfly/litefs/releases). 11 | LiteFS can run on either `amd64` or `arm64` architectures. 12 | -------------------------------------------------------------------------------- /machines/guides-examples.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Guides and Examples 3 | layout: docs 4 | nav: machines 5 | objective: Examples on how to use Machines in fun ways. 6 | toc: false 7 | order: 3 8 | --- 9 | 10 | Examples on how to use Machines in fun ways. 11 | -------------------------------------------------------------------------------- /machines/guides-examples/images/testrun-err-empty-response.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/machines/guides-examples/images/testrun-err-empty-response.webp -------------------------------------------------------------------------------- /machines/guides-examples/images/testrun-hello.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/machines/guides-examples/images/testrun-hello.webp -------------------------------------------------------------------------------- /mcp/access-control.html.erb: -------------------------------------------------------------------------------- 1 | --- 2 | title: Access Control 3 | layout: framework_docs_overview 4 | toc: false 5 | order: 5 6 | --- 7 | 8 |

9 | Making an MCP server available on the internet is a security risk. Most MCP servers are stdio and therefore not designed to be exposed to the internet. 10 | We recommend that you start with HTTP Authorization and only explore other options if you have specific needs. 11 |

12 | 13 |

14 | Following are some of the ways to secure your MCP server: 15 |

-------------------------------------------------------------------------------- /mcp/access-control/reverse-proxy.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Reverse Proxy 3 | layout: framework_docs 4 | objective: Shows how to use a reverse proxy to access your application 5 | status: beta 6 | order: 3 7 | --- 8 | 9 |
10 | Coming soon! 11 |
12 | 13 | Future content to be based on: 14 | * [Rate Limiter Demo](https://github.com/fly-apps/rate-limiter-demo?tab=readme-ov-file#container-demo) 15 | * [NGINX reverse proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) 16 | -------------------------------------------------------------------------------- /mcp/deploy-on/container.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: A container 3 | layout: framework_docs 4 | objective: Demonstrates running an MCP server in a container on a fly machine 5 | status: beta 6 | order: 2 7 | --- 8 | 9 |
10 | Coming soon! 11 |
12 | 13 | Future content to be based on: 14 | 15 | * [Rate Limiter Demo](https://github.com/fly-apps/rate-limiter-demo?tab=readme-ov-file#container-demo) 16 | * [Prisma React Router 7 Example](https://github.com/prisma/prisma-examples/tree/latest/orm/react-router-7#react-router-7-example) 17 | * [SQLite MCP Server](https://github.com/modelcontextprotocol/servers/tree/main/src/sqlite#sqlite-mcp-server) 18 | -------------------------------------------------------------------------------- /mpg/index.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Managed Postgres 3 | layout: docs 4 | nav: firecracker 5 | toc: false 6 | --- 7 | 8 | Fly.io's Managed Postgres is our fully-managed database service that handles all aspects of running production PostgreSQL databases. We take care of backups, high availability, failover, security patches, and version upgrades, allowing you to focus on your application. Cluster storage automatically grows up to 1TB. 9 | 10 | - **[Managed Postgres Overview](/docs/mpg/overview/):** Learn about what Managed Postgres includes, how to create instances, connection details, pricing, and available regions. -------------------------------------------------------------------------------- /partials/_back_to_docs.html.erb: -------------------------------------------------------------------------------- 1 | 2 | Docs Index 3 | -------------------------------------------------------------------------------- /partials/_legacy_apps_doc.html.erb: -------------------------------------------------------------------------------- 1 |
2 | This document applies to Fly Apps running on our legacy "Apps V1" platform, which uses Hashicorp Nomad for orchestration. 3 |
-------------------------------------------------------------------------------- /partials/_machines_toc_nav.html.erb: -------------------------------------------------------------------------------- 1 | <%= partial "/docs/partials/back_to_docs" %> 2 | <%= nav_link "Machines API", "/docs/machines/api/", class: "index-link" %> 3 | <%= table_of_contents(current_page) %> -------------------------------------------------------------------------------- /partials/_obsolete_doc.html.erb: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /partials/_set_secrets.html.erb: -------------------------------------------------------------------------------- 1 | ```cmd 2 | fly secrets set DATABASE_URL=postgres://example.com/mydb <%= defined?(app_name) && "-a #{app_name}" %> 3 | ``` 4 | 5 | -------------------------------------------------------------------------------- /partials/_sign_in.html.erb: -------------------------------------------------------------------------------- 1 | If you already have a Fly.io account, all you need to do is sign in with flyctl. To sign in, run: 2 | 3 | ```cmd 4 | fly auth login 5 | ``` 6 | 7 | When your browser opens to the Fly.io sign-in screen, enter your user name and password to sign in. If you signed up with GitHub, then click `Sign in with GitHub` to sign in. 8 | 9 | After logging in you'll be returned to your command line, ready to use Fly.io. 10 | 11 |
12 | Microsoft WSL users may need to run the following command, which creates a symbolic link that allows the browser to open: 13 | 14 | `ln -s /usr/bin/wslview /usr/local/bin/xdg-open` 15 |
16 | -------------------------------------------------------------------------------- /partials/_simple_list.html.erb: -------------------------------------------------------------------------------- 1 |
2 |
3 | <%= nav_link nav[:title], nav[:path], class: "index-link" %> 4 |
5 |
6 |
    7 | <% nav[:links].each do |page| %> 8 |
  • <%= render_accordion_item(page) %>
    • 9 | <% end %> 10 |
11 |
12 |
-------------------------------------------------------------------------------- /partials/_v2_needs_update.erb: -------------------------------------------------------------------------------- 1 |
We haven't yet updated this page for Fly Machines, which are the VMs now at the core of all Fly Apps. You might notice that some features don't work the same way anymore. Visit our community forum if you need help with your app.
2 | -------------------------------------------------------------------------------- /partials/docs/_litefs_sunset.html.erb: -------------------------------------------------------------------------------- 1 |
2 | **LiteFS Cloud will be retired October 15, 2024.** [LiteFS](https://github.com/superfly/litefs) itself is not affected by the retirement of the LiteFS Cloud service. Learn more about how to disconnect from LiteFS Cloud and other options for disaster recovery in our community post: [Sunsetting LiteFS Cloud](https://community.fly.io/t/sunsetting-litefs-cloud/20829). 3 |
-------------------------------------------------------------------------------- /partials/docs/_volumes_access.html.erb: -------------------------------------------------------------------------------- 1 | Access and write to a volume on a Machine just like a regular directory. 2 | 3 | For Machines managed with Fly Launch, the `destination` under `[mounts]` in `fly.toml` is the path for the mounted volumes. 4 | 5 | For unmanaged Machines, you specify the mount path when you [add a volume to a cloned Machine](#add-a-volume-to-an-unmanaged-machine) or [create a Machine and attach a volume](/docs/machines/flyctl/fly-machine-run/#mount-a-fly-volume). 6 | -------------------------------------------------------------------------------- /partials/flyctl/_auth_login.html.erb: -------------------------------------------------------------------------------- 1 | ```cmd 2 | fly auth login 3 | ``` 4 | 5 | ```output 6 | Opening browser to url https://fly.io/app/auth/cli/token 7 | Waiting for session...⣽ 8 | ``` 9 | 10 | This will open a browser window you can use to register and authenticate with Fly.io. -------------------------------------------------------------------------------- /postgres/advanced-guides.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Advanced guides 3 | layout: framework_docs_overview 4 | toc: false 5 | order: 4 6 | --- 7 | 8 | Fly.io makes it possible to build out high performance Postgres clusters that are accessible globally, but it does require some consideration and architecture thanks to latency imposed by the speed of light, which is approximately 204,190,477 m/s in a fiber optic cable. -------------------------------------------------------------------------------- /postgres/connecting.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Connecting to Fly Postgres 3 | layout: framework_docs_overview 4 | toc: false 5 | order: 2 6 | --- 7 | 8 | Access Postgres from your application to query data, perform migrations, and all the other stuff that needs to be done to make a database useful. -------------------------------------------------------------------------------- /postgres/getting-started.html.markerb: -------------------------------------------------------------------------------- 1 | --- 2 | title: Getting Started 3 | order: 1 4 | toc: false 5 | layout: framework_docs_overview 6 | subnav_glob: docs/rails/getting-started/*.html.* 7 | objective: Quickly get a Postgres instance up and running on Fly. 8 | --- 9 | -------------------------------------------------------------------------------- /postgres/managing.html.markerb: -------------------------------------------------------------------------------- 1 | --- 2 | title: Managing Fly Postgres 3 | layout: framework_docs_overview 4 | toc: false 5 | order: 3 6 | --- 7 | -------------------------------------------------------------------------------- /postgres/managing/deleting.html.markerb: -------------------------------------------------------------------------------- 1 | --- 2 | title: Delete a Postgres Cluster 3 | objective: 4 | layout: framework_docs 5 | order: 90 6 | toc: false 7 | --- 8 | 9 | **Before deleting any app with a volume, including a Fly Postgres app, make certain that you no longer need any of its data; once an app is deleted, its volumes are deleted and you lose access to their snapshots too.** 10 | 11 | If you no longer need any database that a Fly Postgres app serves, you can delete the cluster with `fly apps destroy `. 12 | 13 | Double-check which databases live on the cluster using `fly pg db list -a `. -------------------------------------------------------------------------------- /postgres/managing/horizontal-scaling.html.markerb: -------------------------------------------------------------------------------- 1 | --- 2 | title: Horizontal Scaling 3 | objective: 4 | layout: framework_docs 5 | order: 50 6 | toc: false 7 | --- 8 | 9 | Horizontally scale your Postgres cluster with the [`flyctl machine clone`](https://fly.io/docs/flyctl/machine-clone/) command. Here's an example: 10 | 11 | ```cmd 12 | fly machine clone e784079b449483 --region ord --app pg-test 13 | ``` 14 | 15 | You can use [`fly machine status`](/docs/flyctl/machine-status/) to confirm the state of the cluster. 16 | -------------------------------------------------------------------------------- /python/do-more.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Do More 3 | layout: framework_docs_overview 4 | toc: false 5 | order: 4 6 | --- 7 | 8 | You got your python app up and running, now what? There's lots of appliances you can add to your python project, in these guides we explore how to set them up on the fly.io side as well as in your python app. -------------------------------------------------------------------------------- /python/frameworks.html.markerb: -------------------------------------------------------------------------------- 1 | --- 2 | title: Python Framework Guides 3 | layout: framework_docs_overview 4 | toc: false 5 | order: 3 6 | --- 7 | 8 | 9 |

Each one of the language guides will take you through creating and deploying a simple application.

10 | 11 |

If you don't see a framework supported here that you'd like to run on Fly.io, <%=link_to "tell us in the Community", "https://community.fly.io/" %>.

12 | -------------------------------------------------------------------------------- /python/partials/_poetry_new.erb: -------------------------------------------------------------------------------- 1 | For managing our project, we use [Poetry](https://python-poetry.org/). 2 | For more information on the initial setup with poetry, refer to [setting up a python environment](/docs/python/the-basics/initial-setup). 3 | We can initialize a new project like so: 4 | 5 | ```cmd 6 | poetry new <%= runtime.downcase %>-app 7 | cd <%= runtime.downcase %>-app 8 | poetry shell 9 | ``` -------------------------------------------------------------------------------- /python/partials/_speedrun.erb: -------------------------------------------------------------------------------- 1 | The fastest way to get a basic <%= runtime.titleize %> server on Fly.io is to use our <%= runtime %> template: 2 | 3 | ```cmd 4 | git clone git@github.com:fly-apps/<%= repo %>.git <%= runtime.downcase %>-app 5 | cd <%= runtime.downcase %>-app 6 | fly launch --generate-name 7 | ``` -------------------------------------------------------------------------------- /rails/advanced-guides.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Advanced guides 3 | layout: framework_docs_overview 4 | toc: false 5 | order: 3 6 | --- 7 | 8 | As your Rails application becomes more popular, it will inevitably grow in complexity, the number of people using it will increase, and pretty much everything else goes up and to the right. Fortunately Fly can reduce some of that complexity by making global deployments easy and provide some best practices for scaling a Rails application on Fly. -------------------------------------------------------------------------------- /rails/cookbooks/minimal/Dockerfile1: -------------------------------------------------------------------------------- 1 | # syntax = docker/dockerfile:1 2 | 3 | FROM ruby 4 | 5 | RUN gem install rails 6 | RUN rails new demo --minimal --skip-active-record 7 | 8 | COPY <<-"EOF" /demo/config/routes.rb 9 | Rails.application.routes.draw { root "rails/welcome#index" } 10 | EOF 11 | 12 | WORKDIR demo 13 | ENV RAILS_ENV=production 14 | EXPOSE 3000 15 | CMD bin/rails server 16 | -------------------------------------------------------------------------------- /rails/cookbooks/minimal/Dockerfile2: -------------------------------------------------------------------------------- 1 | # syntax = docker/dockerfile:1 2 | 3 | FROM ruby:slim 4 | 5 | RUN apt-get update &&\ 6 | apt-get install --yes build-essential git 7 | 8 | RUN gem install rails 9 | RUN rails new demo --minimal --skip-active-record 10 | 11 | COPY <<-"EOF" /demo/config/routes.rb 12 | Rails.application.routes.draw { root "rails/welcome#index" } 13 | EOF 14 | 15 | WORKDIR demo 16 | ENV RAILS_ENV=production 17 | EXPOSE 3000 18 | CMD bin/rails server 19 | -------------------------------------------------------------------------------- /rails/cookbooks/minimal/Dockerfile3: -------------------------------------------------------------------------------- 1 | # syntax = docker/dockerfile:1 2 | 3 | FROM ruby:slim as build 4 | 5 | RUN apt-get update &&\ 6 | apt-get install --yes build-essential git 7 | 8 | RUN gem install rails 9 | RUN rails new demo --minimal --skip-active-record 10 | 11 | FROM ruby:slim 12 | 13 | COPY --from=build /demo /demo 14 | COPY --from=build /usr/local/bundle /usr/local/bundle 15 | 16 | COPY <<-"EOF" /demo/config/routes.rb 17 | Rails.application.routes.draw { root "rails/welcome#index" } 18 | EOF 19 | 20 | WORKDIR demo 21 | ENV RAILS_ENV=production 22 | EXPOSE 3000 23 | CMD bin/rails server 24 | -------------------------------------------------------------------------------- /rails/one-pager.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Rails One Pager 3 | layout: one-pager 4 | status: alpha 5 | toc: false 6 | paths: 7 | - docs/rails/getting-started 8 | - docs/rails/the-basics 9 | - docs/rails/advanced-guides 10 | --- 11 | 12 | Most of the documentation from the sidebar, but all on one big page so you can search your way to victory via `Ctrl + F` or `Cmd + F`. -------------------------------------------------------------------------------- /rails/the-basics.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: The Basics 3 | layout: framework_docs_overview 4 | toc: false 5 | order: 2 6 | --- 7 | 8 | Most Rails applications require additional setup beyond provisioning a Postgres and Redis database. These guides will help you get through the basics of setting up your Rails application with pieces of infrastructure commonly found in medium-to-high complexity Rails applications. -------------------------------------------------------------------------------- /reference/machines/_create_app.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X POST \\ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 4 | "${FLY_API_HOSTNAME}/v1/apps" \\ 5 | -d '{ 6 | "app_name": "my-app-name", 7 | "org_slug": "personal", 8 | "network": "my-app-name-network" 9 | }' 10 | 11 | ``` 12 | **Status: 201** 13 | -------------------------------------------------------------------------------- /reference/machines/_create_app_req.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X POST \\ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 4 | "${FLY_API_HOSTNAME}/v1/apps" \\ 5 | -d '{ 6 | "app_name": "my-app-name", 7 | "org_slug": "personal" 8 | }' 9 | 10 | ``` 11 | **Status: 201** -------------------------------------------------------------------------------- /reference/machines/_create_req.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X POST \\ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 4 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines" \\ 5 | -d '{ 6 | "config": { 7 | "init": { 8 | "exec": [ 9 | "/bin/sleep", 10 | "inf" 11 | ] 12 | }, 13 | "image": "registry-1.docker.io/library/ubuntu:latest", 14 | "auto_destroy": true, 15 | "restart": { 16 | "policy": "always" 17 | }, 18 | "guest": { 19 | "cpu_kind": "shared", 20 | "cpus": 1, 21 | "memory_mb": 256 22 | } 23 | } 24 | } 25 | ``` -------------------------------------------------------------------------------- /reference/machines/_delete.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X DELETE \\ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 4 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/d5683210c7968e" 5 | 6 | ``` 7 | **Status: 200** 8 | ```json 9 | { 10 | "ok": true 11 | } 12 | ``` -------------------------------------------------------------------------------- /reference/machines/_delete_app.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X DELETE \\ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 4 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name" 5 | 6 | ``` 7 | **Status: 404** 8 | ```json 9 | { 10 | "error": "Could not find App \"my-app-name\"" 11 | } 12 | ``` -------------------------------------------------------------------------------- /reference/machines/_delete_app_req.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X DELETE \\ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 4 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name" 5 | 6 | ``` 7 | **Status: 202** -------------------------------------------------------------------------------- /reference/machines/_delete_app_resp.erb: -------------------------------------------------------------------------------- 1 | 2 | ```json 3 | { 4 | "error": "Could not find App" 5 | } 6 | ``` -------------------------------------------------------------------------------- /reference/machines/_delete_req.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X DELETE \\ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 4 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/24d896dec64879" 5 | ``` 6 | -------------------------------------------------------------------------------- /reference/machines/_delete_resp.erb: -------------------------------------------------------------------------------- 1 | **Status: 200 OK** 2 | 3 | ```json 4 | { 5 | "ok": true 6 | } 7 | ``` -------------------------------------------------------------------------------- /reference/machines/_get_app.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X GET \\ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 4 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name" 5 | 6 | ``` 7 | **Status: 200** 8 | ```json 9 | { 10 | "name": "my-app-name", 11 | "organization": { 12 | "name": "My Org", 13 | "slug": "personal" 14 | } 15 | } 16 | ``` -------------------------------------------------------------------------------- /reference/machines/_get_app_req.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X GET \\ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 4 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name" 5 | 6 | ``` 7 | **Status: 200** -------------------------------------------------------------------------------- /reference/machines/_get_app_resp.erb: -------------------------------------------------------------------------------- 1 | 2 | ```json 3 | { 4 | "name": "my-app-name", 5 | "organization": { 6 | "name": "My Org", 7 | "slug": "personal" 8 | } 9 | } 10 | ``` -------------------------------------------------------------------------------- /reference/machines/_get_req.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X GET \\ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 4 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/73d8d46dbee589" 5 | 6 | ``` -------------------------------------------------------------------------------- /reference/machines/_lease.erb: -------------------------------------------------------------------------------- 1 | #### How to use the provided `nonce` 2 | 3 | Add the `fly-machine-lease-nonce` header to all subsequent API calls. 4 | 5 | For example: 6 | 7 | ``` 8 | curl -i -X POST \ 9 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" -H "fly-machine-lease-nonce: fed368b018e9" \ 10 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/3d8d413b29d089/stop" 11 | ``` 12 | 13 | #### Release the lease 14 | 15 | For example: 16 | 17 | ``` 18 | curl -i -X DELETE \ 19 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" -H "fly-machine-lease-nonce: fed368b018e9" \ 20 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/3d8d413b29d089/lease" 21 | ``` 22 | -------------------------------------------------------------------------------- /reference/machines/_lease_req.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X POST \ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \ 4 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/3d8d413b29d089/lease" \ 5 | -d '{ 6 | "ttl": 500 7 | }' 8 | ``` 9 | -------------------------------------------------------------------------------- /reference/machines/_lease_resp.erb: -------------------------------------------------------------------------------- 1 | **Status: 201 Created** 2 | 3 | ```json 4 | { 5 | "status":"success", 6 | "data": { 7 | "nonce":"fed368b018e9", 8 | "expires_at":1666295946, 9 | "owner":"hello@fly.io" 10 | } 11 | } 12 | ``` 13 | 14 | **Status: 409 Conflict** 15 | 16 | ```json 17 | { 18 | "status":"error", 19 | "message":"machine ID 3d8d413b29d089 lease currently held by hello@fly.io, expires at 2022-10-20 19:59:06 +0000 UTC", 20 | "code":"invalid" 21 | } 22 | ``` 23 | -------------------------------------------------------------------------------- /reference/machines/_list_req.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X GET \\ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 4 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines" 5 | 6 | ``` 7 | -------------------------------------------------------------------------------- /reference/machines/_machines_cordon_req.erb: -------------------------------------------------------------------------------- 1 | curl -i -X POST \\ 2 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 3 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/73d8d46dbee589/cordon" -------------------------------------------------------------------------------- /reference/machines/_machines_create_req.erb: -------------------------------------------------------------------------------- 1 | curl -i -X POST \\ 2 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 3 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines" \\ 4 | -d '{ 5 | "config": { 6 | "init": { 7 | "exec": [ 8 | "/bin/sleep", 9 | "inf" 10 | ] 11 | }, 12 | "image": "registry-1.docker.io/library/ubuntu:latest", 13 | "auto_destroy": true, 14 | "restart": { 15 | "policy": "always" 16 | }, 17 | "guest": { 18 | "cpu_kind": "shared", 19 | "cpus": 1, 20 | "memory_mb": 256 21 | } 22 | } 23 | }' -------------------------------------------------------------------------------- /reference/machines/_machines_delete_req.erb: -------------------------------------------------------------------------------- 1 | curl -i -X DELETE \\ 2 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 3 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/24d896dec64879?force=true" -------------------------------------------------------------------------------- /reference/machines/_machines_get_req.erb: -------------------------------------------------------------------------------- 1 | curl -i -X GET \\ 2 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 3 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/73d8d46dbee589" -------------------------------------------------------------------------------- /reference/machines/_machines_lease_create_req.erb: -------------------------------------------------------------------------------- 1 | curl -i -X POST \\ 2 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 3 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/3d8d413b29d089/lease" \\ 4 | -d '{ 5 | "description": "", 6 | "ttl": 500 7 | }' 8 | -------------------------------------------------------------------------------- /reference/machines/_machines_lease_create_resp.erb: -------------------------------------------------------------------------------- 1 | { 2 | "status": "success", 3 | "data": { 4 | "nonce": "5c35f65c9f95", 5 | "expires_at": 1708569778, 6 | "owner": "hello@fly.io", 7 | "description": "", 8 | "version": "01HQ73A7BFFDF1B6WMGHFZZ4E7" 9 | } 10 | } -------------------------------------------------------------------------------- /reference/machines/_machines_lease_get_req.erb: -------------------------------------------------------------------------------- 1 | curl -i -X GET \\ 2 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 3 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/3d8d413b29d089/lease" 4 | -------------------------------------------------------------------------------- /reference/machines/_machines_lease_get_resp.erb: -------------------------------------------------------------------------------- 1 | { 2 | "status": "success", 3 | "data": { 4 | "nonce": "5c35f65c9f95", 5 | "expires_at": 1708569778, 6 | "owner": "hello@fly.io", 7 | "description": "", 8 | "version": "01HQ73A7BFFDF1B6WMGHFZZ4E7" 9 | } 10 | } -------------------------------------------------------------------------------- /reference/machines/_machines_lease_release_req.erb: -------------------------------------------------------------------------------- 1 | curl -i -X DELETE \\ 2 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" -H "fly-machine-lease-nonce: fed368b018e9" \\ 3 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/3d8d413b29d089/lease" -------------------------------------------------------------------------------- /reference/machines/_machines_lease_release_resp.erb: -------------------------------------------------------------------------------- 1 | { 2 | "status": "success", 3 | "data": { 4 | "ok": true 5 | } 6 | } -------------------------------------------------------------------------------- /reference/machines/_machines_list_req.erb: -------------------------------------------------------------------------------- 1 | curl -i -X GET \\ 2 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 3 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines" 4 | -------------------------------------------------------------------------------- /reference/machines/_machines_metadata_delete_req.erb: -------------------------------------------------------------------------------- 1 | curl -i -X DELETE \\ 2 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 3 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/9080e339b57798/metadata/foo-key" -------------------------------------------------------------------------------- /reference/machines/_machines_metadata_delete_resp.erb: -------------------------------------------------------------------------------- 1 | no body -------------------------------------------------------------------------------- /reference/machines/_machines_metadata_get_req.erb: -------------------------------------------------------------------------------- 1 | curl -i -X GET \\ 2 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 3 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/9080e339b57798/metadata" -------------------------------------------------------------------------------- /reference/machines/_machines_metadata_get_resp.erb: -------------------------------------------------------------------------------- 1 | { 2 | "fly_flyctl_version":"0.2.8", 3 | "fly_platform_version":"v2", 4 | "fly_process_group":"app", 5 | "fly_release_id":"Nj7oGMlVVpZ7JToybJoXLLjMl", 6 | "fly_release_version":"63" 7 | } -------------------------------------------------------------------------------- /reference/machines/_machines_metadata_update_req.erb: -------------------------------------------------------------------------------- 1 | curl -i -X POST \\ 2 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 3 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/9080e339b57798/metadata/foo-key" \\ 4 | -d '{ 5 | "value":"bar" 6 | }' -------------------------------------------------------------------------------- /reference/machines/_machines_metadata_update_resp.erb: -------------------------------------------------------------------------------- 1 | no body -------------------------------------------------------------------------------- /reference/machines/_machines_ok_true_resp.erb: -------------------------------------------------------------------------------- 1 | { 2 | "ok": true 3 | } -------------------------------------------------------------------------------- /reference/machines/_machines_start_req.erb: -------------------------------------------------------------------------------- 1 | curl -i -X POST \\ 2 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 3 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/73d8d46dbee589/start" -------------------------------------------------------------------------------- /reference/machines/_machines_start_resp.erb: -------------------------------------------------------------------------------- 1 | { 2 | "previous_state": "stopped", 3 | "migrated": false, 4 | "new_host": "" 5 | } -------------------------------------------------------------------------------- /reference/machines/_machines_stop_req.erb: -------------------------------------------------------------------------------- 1 | curl -i -X POST \\ 2 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 3 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/73d8d46dbee589/stop" -------------------------------------------------------------------------------- /reference/machines/_machines_suspend_req.erb: -------------------------------------------------------------------------------- 1 | curl -i -X POST \\ 2 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 3 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/73d8d46dbee589/suspend" -------------------------------------------------------------------------------- /reference/machines/_machines_uncordon_req.erb: -------------------------------------------------------------------------------- 1 | curl -i -X POST \\ 2 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 3 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/73d8d46dbee589/uncordon" 4 | -------------------------------------------------------------------------------- /reference/machines/_machines_wait_req.erb: -------------------------------------------------------------------------------- 1 | curl -i -X GET \\ 2 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 3 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/73d8d46dbee589/wait?state=stopped&instance_id=01HMVXC16ED6SHK9452AF029Y7" -------------------------------------------------------------------------------- /reference/machines/_start.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X POST \\ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 4 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/d5683210c7968e/start" 5 | 6 | ``` 7 | **Status: 200** 8 | ```json 9 | { 10 | "previous_state": "stopped" 11 | } 12 | ``` -------------------------------------------------------------------------------- /reference/machines/_start_req.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X POST \\ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 4 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/73d8d46dbee589/start" 5 | 6 | ``` 7 | **Status: 200** -------------------------------------------------------------------------------- /reference/machines/_start_resp.erb: -------------------------------------------------------------------------------- 1 | 2 | ```json 3 | { 4 | "previous_state": "stopped" 5 | } 6 | ``` -------------------------------------------------------------------------------- /reference/machines/_stop.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X POST \\ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 4 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/d5683210c7968e/stop" 5 | 6 | ``` 7 | **Status: 200** 8 | ```json 9 | { 10 | "ok": true 11 | } 12 | ``` -------------------------------------------------------------------------------- /reference/machines/_stop_req.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X POST \\ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 4 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/73d8d46dbee589/stop" 5 | 6 | ``` 7 | **Status: 200** -------------------------------------------------------------------------------- /reference/machines/_stop_resp.erb: -------------------------------------------------------------------------------- 1 | 2 | ```json 3 | { 4 | "ok": true 5 | } 6 | ``` -------------------------------------------------------------------------------- /reference/machines/_wait.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X GET \\ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 4 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/d5683210c7968e/wait" 5 | 6 | ``` 7 | **Status: 200** 8 | ```json 9 | { 10 | "ok": true 11 | } 12 | ``` -------------------------------------------------------------------------------- /reference/machines/_wait_req.erb: -------------------------------------------------------------------------------- 1 | ``` 2 | curl -i -X GET \\ 3 | -H "Authorization: Bearer ${FLY_API_TOKEN}" -H "Content-Type: application/json" \\ 4 | "${FLY_API_HOSTNAME}/v1/apps/my-app-name/machines/73d8d46dbee589/wait?instance_id=01GXPEEEOF95AYV5J1HYLGZ8P1&state=stopped" 5 | 6 | ``` 7 | **Status: 200** -------------------------------------------------------------------------------- /reference/machines/_wait_resp.erb: -------------------------------------------------------------------------------- 1 | 2 | ```json 3 | { 4 | "ok": true 5 | } 6 | ``` -------------------------------------------------------------------------------- /retired-launcher.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Sorry, that launcher is retired! 3 | layout: docs 4 | nav: firecracker 5 | toc: false 6 | --- 7 | 8 | We've retired our web-based launchers for individual apps like Jupyter and code-server. You can launch these apps yourself, with the `fly launch` command. Apps that have their own official Docker images are especially convenient. Here are a couple of places to start: 9 | 10 | [Speedrun: Launch on Fly.io](/docs/getting-started/launch/) 11 | 12 | [Deploy via Dockerfile](/docs/languages-and-frameworks/dockerfile/) 13 | 14 | -------------------------------------------------------------------------------- /rust/frameworks.html.markerb: -------------------------------------------------------------------------------- 1 | --- 2 | title: Rust Framework Guides 3 | layout: framework_docs_overview 4 | toc: false 5 | order: 4 6 | --- 7 | 8 | 9 |

Each one of the language guides will take you through creating and deploying a simple application.

10 | 11 |

If you don't see a framework supported here that you'd like to run on Fly.io, <%=link_to "tell us in the Community", "https://community.fly.io/" %>.

12 | -------------------------------------------------------------------------------- /rust/partials/_cargo-new.html.erb: -------------------------------------------------------------------------------- 1 | If you don't already have an existing Axum application, you can create one with `cargo`: 2 | 3 | ```cmd 4 | cargo new <%= runtime %>-on-fly 5 | cd <%= runtime %>-on-fly 6 | ``` -------------------------------------------------------------------------------- /rust/partials/_speedrun.html.erb: -------------------------------------------------------------------------------- 1 | The fastest way to get a basic <%= runtime.titleize %> server on Fly.io is to use our <%= runtime %> template: 2 | 3 | ```cmd 4 | git clone --single-branch --branch <%= runtime %> git@github.com:superfly/rust-templates.git <%= runtime %>-app 5 | cd <%= runtime %>-app 6 | fly launch --generate-name 7 | ``` -------------------------------------------------------------------------------- /styles/Fly/Exclamation.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Use exclamation points sparingly." 3 | nonword: true 4 | level: suggestion 5 | action: 6 | name: remove 7 | tokens: 8 | - '\w+!(?:\s|$)' 9 | -------------------------------------------------------------------------------- /styles/Fly/Headings.yml: -------------------------------------------------------------------------------- 1 | extends: capitalization 2 | message: "'%s' should use sentence-style capitalization." 3 | level: suggestion 4 | scope: heading 5 | match: $sentence 6 | indicators: 7 | - ':' 8 | exceptions: 9 | - CLI 10 | - Docker 11 | - Elixir 12 | - Fly 13 | - Fly Proxy 14 | - gRPC 15 | - I 16 | - Kubernetes 17 | - Linux 18 | - Machine 19 | - Machines 20 | - macOS 21 | - MongoDB 22 | - Nomad 23 | - Rails 24 | - Ruby 25 | - REPL 26 | - TypeScript 27 | - URLs 28 | - Windows -------------------------------------------------------------------------------- /styles/Fly/Latin.yml: -------------------------------------------------------------------------------- 1 | extends: substitution 2 | message: "Use '%s' instead of '%s'." 3 | ignorecase: true 4 | level: suggestion 5 | nonword: true 6 | action: 7 | name: replace 8 | swap: 9 | '\b(?:eg|e\.g\.)(?=[\s,;])': for example 10 | '\b(?:ie|i\.e\.)(?=[\s,;])': that is 11 | '\b(?:viz\.)[\s,]': namely 12 | '\b(?:ergo)[\s,]': therefore 13 | 14 | -------------------------------------------------------------------------------- /styles/Fly/Machine.yml: -------------------------------------------------------------------------------- 1 | # This file tests some combinations of matches to try to avoid errors on proper usage. 2 | extends: substitution 3 | 4 | message: "Use '%s' instead of '%s'." 5 | 6 | level: suggestion 7 | 8 | swap: 9 | '(?=1.0.0" 4 | } 5 | -------------------------------------------------------------------------------- /styles/Google/vocab.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/superfly/docs/eab92110b48ae420f068b922da48c7306b602a12/styles/Google/vocab.txt -------------------------------------------------------------------------------- /styles/config/vocabularies/fly-terms/reject.txt: -------------------------------------------------------------------------------- 1 | (?i)healthcheck(s) -------------------------------------------------------------------------------- /styles/proselint/Airlinese.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "'%s' is airlinese." 3 | ignorecase: true 4 | level: suggestion 5 | tokens: 6 | - enplan(?:e|ed|ing|ement) 7 | - deplan(?:e|ed|ing|ement) 8 | - taking off momentarily 9 | -------------------------------------------------------------------------------- /styles/proselint/Annotations.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "'%s' left in text." 3 | ignorecase: false 4 | level: suggestion 5 | tokens: 6 | - XXX 7 | - FIXME 8 | - TODO 9 | - NOTE 10 | - TBD 11 | -------------------------------------------------------------------------------- /styles/proselint/Apologizing.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Excessive apologizing: '%s'" 3 | ignorecase: true 4 | level: suggestion 5 | action: 6 | name: remove 7 | tokens: 8 | - More research is needed 9 | -------------------------------------------------------------------------------- /styles/proselint/But.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Do not start a paragraph with a 'but'." 3 | level: suggestion 4 | scope: paragraph 5 | action: 6 | name: remove 7 | tokens: 8 | - ^But 9 | -------------------------------------------------------------------------------- /styles/proselint/Currency.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Incorrect use of symbols in '%s'." 3 | ignorecase: true 4 | raw: 5 | - \$[\d]* ?(?:dollars|usd|us dollars) 6 | -------------------------------------------------------------------------------- /styles/proselint/Cursing.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Consider replacing '%s'." 3 | level: suggestion 4 | ignorecase: true 5 | tokens: 6 | - shit 7 | - piss 8 | - fuck 9 | - cunt 10 | - cocksucker 11 | - motherfucker 12 | - tits 13 | - fart 14 | - turd 15 | - twat 16 | -------------------------------------------------------------------------------- /styles/proselint/DateCase.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: With lowercase letters, the periods are standard. 3 | ignorecase: false 4 | level: suggestion 5 | nonword: true 6 | tokens: 7 | - '\d{1,2} ?[ap]m\b' 8 | -------------------------------------------------------------------------------- /styles/proselint/DateMidnight.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Use 'midnight' or 'noon'." 3 | ignorecase: true 4 | level: suggestion 5 | nonword: true 6 | tokens: 7 | - '12 ?[ap]\.?m\.?' 8 | -------------------------------------------------------------------------------- /styles/proselint/DateRedundancy.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "'a.m.' is always morning; 'p.m.' is always night." 3 | ignorecase: true 4 | level: suggestion 5 | nonword: true 6 | tokens: 7 | - '\d{1,2} ?a\.?m\.? in the morning' 8 | - '\d{1,2} ?p\.?m\.? in the evening' 9 | - '\d{1,2} ?p\.?m\.? at night' 10 | - '\d{1,2} ?p\.?m\.? in the afternoon' 11 | -------------------------------------------------------------------------------- /styles/proselint/DateSpacing.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "It's standard to put a space before '%s'" 3 | ignorecase: true 4 | level: suggestion 5 | nonword: true 6 | tokens: 7 | - '\d{1,2}[ap]\.?m\.?' 8 | -------------------------------------------------------------------------------- /styles/proselint/Hedging.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "'%s' is hedging." 3 | ignorecase: true 4 | level: suggestion 5 | tokens: 6 | - I would argue that 7 | - ', so to speak' 8 | - to a certain degree 9 | -------------------------------------------------------------------------------- /styles/proselint/Hyperbole.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "'%s' is hyperbolic." 3 | level: suggestion 4 | nonword: true 5 | tokens: 6 | - '[a-z]+[!?]{2,}' 7 | -------------------------------------------------------------------------------- /styles/proselint/Jargon.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "'%s' is jargon." 3 | ignorecase: true 4 | level: suggestion 5 | tokens: 6 | - in the affirmative 7 | - in the negative 8 | - agendize 9 | - per your order 10 | - per your request 11 | - disincentivize 12 | -------------------------------------------------------------------------------- /styles/proselint/LGBTOffensive.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "'%s' is offensive. Remove it or consider the context." 3 | ignorecase: true 4 | tokens: 5 | - fag 6 | - faggot 7 | - dyke 8 | - sodomite 9 | - homosexual agenda 10 | - gay agenda 11 | - transvestite 12 | - homosexual lifestyle 13 | - gay lifestyle 14 | -------------------------------------------------------------------------------- /styles/proselint/LGBTTerms.yml: -------------------------------------------------------------------------------- 1 | extends: substitution 2 | message: "Consider using '%s' instead of '%s'." 3 | ignorecase: true 4 | action: 5 | name: replace 6 | swap: 7 | homosexual man: gay man 8 | homosexual men: gay men 9 | homosexual woman: lesbian 10 | homosexual women: lesbians 11 | homosexual people: gay people 12 | homosexual couple: gay couple 13 | sexual preference: sexual orientation 14 | (?:admitted homosexual|avowed homosexual): openly gay 15 | special rights: equal rights 16 | -------------------------------------------------------------------------------- /styles/proselint/Malapropisms.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "'%s' is a malapropism." 3 | ignorecase: true 4 | level: suggestion 5 | tokens: 6 | - the infinitesimal universe 7 | - a serial experience 8 | - attack my voracity 9 | -------------------------------------------------------------------------------- /styles/proselint/Oxymorons.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "'%s' is an oxymoron." 3 | ignorecase: true 4 | level: suggestion 5 | tokens: 6 | - amateur expert 7 | - increasingly less 8 | - advancing backwards 9 | - alludes explicitly to 10 | - explicitly alludes to 11 | - totally obsolescent 12 | - completely obsolescent 13 | - generally always 14 | - usually always 15 | - increasingly less 16 | - build down 17 | - conspicuous absence 18 | - exact estimate 19 | - found missing 20 | - intense apathy 21 | - mandatory choice 22 | - organized mess 23 | -------------------------------------------------------------------------------- /styles/proselint/P-Value.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "You should use more decimal places, unless '%s' is really true." 3 | ignorecase: true 4 | level: suggestion 5 | tokens: 6 | - 'p = 0\.0{2,4}' 7 | -------------------------------------------------------------------------------- /styles/proselint/RASSyndrome.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "'%s' is redundant." 3 | level: suggestion 4 | action: 5 | name: edit 6 | params: 7 | - split 8 | - ' ' 9 | - '0' 10 | tokens: 11 | - ABM missile 12 | - ACT test 13 | - ABM missiles 14 | - ABS braking system 15 | - ATM machine 16 | - CD disc 17 | - CPI Index 18 | - GPS system 19 | - GUI interface 20 | - HIV virus 21 | - ISBN number 22 | - LCD display 23 | - PDF format 24 | - PIN number 25 | - RAS syndrome 26 | - RIP in peace 27 | - please RSVP 28 | - SALT talks 29 | - SAT test 30 | - UPC codes 31 | -------------------------------------------------------------------------------- /styles/proselint/Skunked.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "'%s' is a bit of a skunked term — impossible to use without issue." 3 | ignorecase: true 4 | level: suggestion 5 | tokens: 6 | - bona fides 7 | - deceptively 8 | - decimate 9 | - effete 10 | - fulsome 11 | - hopefully 12 | - impassionate 13 | - Thankfully 14 | -------------------------------------------------------------------------------- /styles/proselint/Spelling.yml: -------------------------------------------------------------------------------- 1 | extends: consistency 2 | message: "Inconsistent spelling of '%s'." 3 | level: suggestion 4 | ignorecase: true 5 | either: 6 | advisor: adviser 7 | centre: center 8 | colour: color 9 | emphasise: emphasize 10 | finalise: finalize 11 | focussed: focused 12 | labour: labor 13 | learnt: learned 14 | organise: organize 15 | organised: organized 16 | organising: organizing 17 | recognise: recognize 18 | -------------------------------------------------------------------------------- /styles/proselint/Typography.yml: -------------------------------------------------------------------------------- 1 | extends: substitution 2 | message: Consider using the '%s' symbol instead of '%s'. 3 | level: suggestion 4 | nonword: true 5 | swap: 6 | '\.\.\.': … 7 | '\([cC]\)': © 8 | '\(TM\)': ™ 9 | '\(tm\)': ™ 10 | '\([rR]\)': ® 11 | '[0-9]+ ?x ?[0-9]+': × 12 | -------------------------------------------------------------------------------- /styles/proselint/Very.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Remove '%s'." 3 | ignorecase: true 4 | level: suggestion 5 | tokens: 6 | - very 7 | -------------------------------------------------------------------------------- /styles/proselint/meta.json: -------------------------------------------------------------------------------- 1 | { 2 | "author": "jdkato", 3 | "description": "A Vale-compatible implementation of the proselint linter.", 4 | "email": "support@errata.ai", 5 | "lang": "en", 6 | "url": "https://github.com/errata-ai/proselint/releases/latest/download/proselint.zip", 7 | "feed": "https://github.com/errata-ai/proselint/releases.atom", 8 | "issues": "https://github.com/errata-ai/proselint/issues/new", 9 | "license": "BSD-3-Clause", 10 | "name": "proselint", 11 | "sources": [ 12 | "https://github.com/amperser/proselint" 13 | ], 14 | "vale_version": ">=1.0.0", 15 | "coverage": 0.0, 16 | "version": "0.1.0" 17 | } 18 | -------------------------------------------------------------------------------- /styles/words2ignore.txt: -------------------------------------------------------------------------------- 1 | args 2 | autoscale 3 | autoscaler 4 | autoscaling 5 | binstubs 6 | bundler 7 | chmod 8 | config 9 | const 10 | cpus 11 | deprioritize 12 | dockerfile-rails 13 | dockerignore 14 | healthcheck 15 | healthchecks 16 | heredocs 17 | IOPs 18 | nomad/v1 19 | num 20 | postgres 21 | sed 22 | subcommand 23 | svg 24 | toml 25 | v1 26 | v2 27 | vm 28 | vms 29 | http 30 | youtube 31 | shopify 32 | unavailabilty 33 | -------------------------------------------------------------------------------- /styles/write-good/E-Prime.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Try to avoid using '%s'." 3 | ignorecase: true 4 | level: suggestion 5 | tokens: 6 | - am 7 | - are 8 | - aren't 9 | - be 10 | - been 11 | - being 12 | - he's 13 | - here's 14 | - here's 15 | - how's 16 | - i'm 17 | - is 18 | - isn't 19 | - it's 20 | - she's 21 | - that's 22 | - there's 23 | - they're 24 | - was 25 | - wasn't 26 | - we're 27 | - were 28 | - weren't 29 | - what's 30 | - where's 31 | - who's 32 | - you're 33 | -------------------------------------------------------------------------------- /styles/write-good/Illusions.yml: -------------------------------------------------------------------------------- 1 | extends: repetition 2 | message: "'%s' is repeated!" 3 | level: suggestion 4 | alpha: true 5 | action: 6 | name: edit 7 | params: 8 | - truncate 9 | - " " 10 | tokens: 11 | - '[^\s]+' 12 | -------------------------------------------------------------------------------- /styles/write-good/So.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Don't start a sentence with '%s'." 3 | level: suggestion 4 | raw: 5 | - '(?:[;-]\s)so[\s,]|\bSo[\s,]' 6 | -------------------------------------------------------------------------------- /styles/write-good/ThereIs.yml: -------------------------------------------------------------------------------- 1 | extends: existence 2 | message: "Don't start a sentence with '%s'." 3 | ignorecase: false 4 | level: suggestion 5 | raw: 6 | - '(?:[;-]\s)There\s(is|are)|\bThere\s(is|are)\b' 7 | -------------------------------------------------------------------------------- /styles/write-good/meta.json: -------------------------------------------------------------------------------- 1 | { 2 | "feed": "https://github.com/errata-ai/write-good/releases.atom", 3 | "vale_version": ">=1.0.0" 4 | } 5 | -------------------------------------------------------------------------------- /supabase/index.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Supabase Postgres 3 | layout: docs 4 | status: alpha 5 | nav: firecracker 6 | redirect_from: /docs/reference/supabase/ 7 | --- 8 | 9 | --------------------------------------------------------------------------------