diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 7de5f1dd0..2b272a418 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -24,6 +24,7 @@ ## 💭 Explanation (Understanding) * [The "Why" of Frigg Technical Decisions](explanation/the-why-of-frigg-technical-decisions.md) +* [Hosts](explanation/hosts.md) ## 📖 Reference (Information) @@ -170,7 +171,7 @@ ## 📞 Support -* [Contact](support/support.md) +* [Get support](support/support.md) * [Frequently Asked Questions (FAQs)](support/frequently-asked-questions.md) ## 🗺️ Roadmap diff --git a/docs/explanation/hosts.md b/docs/explanation/hosts.md new file mode 100644 index 000000000..0b23771c6 --- /dev/null +++ b/docs/explanation/hosts.md @@ -0,0 +1,54 @@ +# Hosts + +Frigg is a framework you run — not a SaaS that hosts your integrations for you. You (or your agents) scaffold an app, then start it locally or deploy it to cloud infrastructure you control. + +Today on `next`, two hosts are supported out of the box: **local** development and **AWS**. Everything else is either in review or still a stub. + +## Supported hosts + +### Local (`frigg start`) + +`frigg start` runs your backend with OSS-Serverless offline (`osls offline`), using the generated `infrastructure.js`. That path skips AWS resource discovery (`FRIGG_SKIP_AWS_DISCOVERY=true`) so you can develop without cloud credentials. + +Default ports from the generated serverless-offline config: + +| Service | Default port | +| --- | --- | +| HTTP API (`serverless-offline` `httpPort`) | **3001** | +| Lambda invoke | 4001 | +| WebSocket | 3002 | + +The Management UI (`frigg ui`) also defaults to **3001**. Until those defaults split, run the UI on another port when both are up: + +```bash +frigg start +frigg ui --port 3210 +``` + +Use whichever free port you like for the UI; the important part is that it is not 3001 while `frigg start` is already bound there. + +### AWS (`frigg deploy`) + +AWS is the only cloud provider implemented on `next`. The provider factory defaults to `aws` when none is set, and deploy tooling expects AWS credentials (`AWS_*` env vars). Region resolution falls back to `AWS_REGION`, then **`us-east-1`**. + +Generated infrastructure targets familiar AWS building blocks (Lambda, API Gateway, optional VPC/RDS/KMS/SSM, and so on). For a hands-on walkthrough, see [Deploying to AWS](../tutorials/advanced-tutorials/deploying-your-frigg-application/deploying-to-aws.md). + +## Not yet supported + +### Netlify — in review + +A Netlify provider adapter is in review ([#686](https://github.com/friggframework/frigg/pull/686) / [#545](https://github.com/friggframework/frigg/pull/545)). It is **not** merged on `next` yet — do not treat Netlify as a supported Frigg app host today. (The marketing site at friggframework.org is published with Netlify; that is separate from deploying a Frigg integration app.) + +### Azure and GCP — stubs only + +Azure and GCP appear in the provider factory as **planned** stubs. Creating either provider throws (“not yet implemented”). Do **not** list them as supported hosts; there is no deploy how-to for them on `next`. + +## Choosing a host + +| Goal | Host | +| --- | --- | +| Develop and debug integrations | Local (`frigg start` + optional `frigg ui`) | +| Ship to production on infrastructure you own | AWS (`frigg deploy`) | +| Netlify / Azure / GCP as the app runtime | Wait for merged support — or contribute | + +Missing something? Request it, or point a coding agent at the relevant spec with our PR instructions; the team reviews for release. diff --git a/docs/support/frequently-asked-questions.md b/docs/support/frequently-asked-questions.md index 9d58dae7c..387bde3e2 100644 --- a/docs/support/frequently-asked-questions.md +++ b/docs/support/frequently-asked-questions.md @@ -134,21 +134,7 @@ Yes, if that tool can facilitate using APIs to authenticate and configure a user Which cloud providers are supported? -Frigg leverages (and requires) the [Serverless.com framework](https://github.com/serverless/serverless), which means it can run on many different cloud services including:\\ - -AWS - -Microsoft Azure - -Google Cloud - -Tencent Cloud - -Cloudflare - -Alibaba Cloud - -twilio +On `next`, Frigg supports **local** development and **AWS** deploy out of the box. See [Hosts](../explanation/hosts.md) for defaults, the Netlify work in review, and why Azure/GCP are not listed as supported yet. diff --git a/docs/support/support.md b/docs/support/support.md index 5420d1c89..09e7aca65 100644 --- a/docs/support/support.md +++ b/docs/support/support.md @@ -1,8 +1,32 @@ -# Contact +# Get support -We have two ways to interact with Frigg's maintainer team: +Stuck on a deploy, unsure which module to reach for, or wondering whether Frigg already covers your use case? Start here — the community and maintainers hang out in a few places, and paid help is available when you need it. -`1.`[`Github Discussions, the official Frigg message board`](https://github.com/frigg/frigg/discussions) +## Community channels -`2.`[`Invite yourself to the Frigg Community Slack Channel`](https://friggframework.org/#contact) +| Channel | Best for | Link | +| --- | --- | --- | +| GitHub Discussions | Questions, ideas, and longer threads that stay searchable | [friggframework/frigg Discussions](https://github.com/friggframework/frigg/discussions) | +| Community Slack | Quick help, war stories, and early looks at new tooling | [Join via friggframework.org](https://friggframework.org/#join) | +### GitHub Discussions + +Open a discussion when you want an answer that others can find later — setup questions, design tradeoffs, or “has anyone done X?” Prefer [Issues](https://github.com/friggframework/frigg/issues) for clear bugs and feature requests with reproduction steps. + +### Community Slack + +Invite yourself to the Frigg Slack Connect channel from the community form on [friggframework.org](https://friggframework.org/#join) (check **Invite me to the Frigg Slack Connect channel** and submit). Slack is great for fast back-and-forth; Discussions are better for lasting reference. + +## Paid help + +Frigg is free and MIT-licensed. The team that builds it also offers commercial support, maintenance, and hands-on integration work through [Left Hook](https://lefthook.com). Reach out there when you want SLAs, premium connectors, or help standing up an integration program. + +## Looking for a feature that isn’t there yet? + +Missing something? Request it, or point a coding agent at the relevant spec with our PR instructions; the team reviews for release. + +## See also + +- [Frequently Asked Questions](frequently-asked-questions.md) +- [Hosts](../explanation/hosts.md) — where Frigg runs today (local and AWS) +- [Contributing](../contributing/contributing/README.md)