-
Notifications
You must be signed in to change notification settings - Fork 0
/
contributing.html
24 lines (22 loc) · 25.1 KB
/
contributing.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Contributing | Lagoss</title>
<meta name="description" content="An open-source runtime and platform that allows developers to run TypeScript and JavaScript Serverless Functions.">
<meta name="generator" content="VitePress v1.0.0-rc.44">
<link rel="preload stylesheet" href="/assets/style.Dl058EZ5.css" as="style">
<script type="module" src="/assets/app.yn0IZKkT.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Bu8hRsVA.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/framework.CSd21wiM.js">
<link rel="modulepreload" href="/assets/chunks/theme.DanHaxrE.js">
<link rel="modulepreload" href="/assets/contributing.md.yZsRwz4D.lean.js">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-5d98c3a5><!--[--><!--]--><!--[--><span tabindex="-1" data-v-0f60ec36></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-0f60ec36> Skip to content </a><!--]--><!----><header class="VPNav" data-v-5d98c3a5 data-v-ae24b3ad><div class="VPNavBar has-sidebar" data-v-ae24b3ad data-v-19c990f1><div class="wrapper" data-v-19c990f1><div class="container" data-v-19c990f1><div class="title" data-v-19c990f1><div class="VPNavBarTitle has-sidebar" data-v-19c990f1 data-v-ab179fa1><a class="title" href="/" data-v-ab179fa1><!--[--><!--]--><!--[--><img class="VPImage logo" src="/icon-white.png" alt data-v-8426fc1a><!--]--><span data-v-ab179fa1>Lagoss</span><!--[--><!--]--></a></div></div><div class="content" data-v-19c990f1><div class="content-body" data-v-19c990f1><!--[--><!--]--><div class="VPNavBarSearch search" data-v-19c990f1><!----></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-19c990f1 data-v-7f418b0f><span id="main-nav-aria-label" class="visually-hidden" data-v-7f418b0f>Main Navigation</span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/" tabindex="0" data-v-7f418b0f data-v-42ef59de><!--[--><span data-v-42ef59de>Home</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/introduction.html" tabindex="0" data-v-7f418b0f data-v-42ef59de><!--[--><span data-v-42ef59de>Docs</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-19c990f1 data-v-e6aabb21><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Switch to dark theme" aria-checked="false" data-v-e6aabb21 data-v-d1f28634 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-d1f28634></span><span class="vpi-moon moon" data-v-d1f28634></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-19c990f1 data-v-0394ad82 data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://github.com/lagossapp/lagoss" aria-label="github" target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><span class="vpi-social-github" /></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-19c990f1 data-v-d0bd9dde data-v-b6c34ac9><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-b6c34ac9><span class="vpi-more-horizontal icon" data-v-b6c34ac9></span></button><div class="menu" data-v-b6c34ac9><div class="VPMenu" data-v-b6c34ac9 data-v-e7ea1737><!----><!--[--><!--[--><!----><div class="group" data-v-d0bd9dde><div class="item appearance" data-v-d0bd9dde><p class="label" data-v-d0bd9dde>Appearance</p><div class="appearance-action" data-v-d0bd9dde><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Switch to dark theme" aria-checked="false" data-v-d0bd9dde data-v-d1f28634 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-d1f28634></span><span class="vpi-moon moon" data-v-d1f28634></span><!--]--></span></span></button></div></div></div><div class="group" data-v-d0bd9dde><div class="item social-links" data-v-d0bd9dde><div class="VPSocialLinks social-links-list" data-v-d0bd9dde data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://github.com/lagossapp/lagoss" aria-label="github" target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><span class="vpi-social-github" /></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-19c990f1 data-v-e5dd9c1c><span class="container" data-v-e5dd9c1c><span class="top" data-v-e5dd9c1c></span><span class="middle" data-v-e5dd9c1c></span><span class="bottom" data-v-e5dd9c1c></span></span></button></div></div></div></div><div class="divider" data-v-19c990f1><div class="divider-line" data-v-19c990f1></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-5d98c3a5 data-v-a6f0e41e><div class="container" data-v-a6f0e41e><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-a6f0e41e><span class="vpi-align-left menu-icon" data-v-a6f0e41e></span><span class="menu-text" data-v-a6f0e41e>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-a6f0e41e data-v-d2ecc192><button data-v-d2ecc192>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-5d98c3a5 data-v-575e6a36><div class="curtain" data-v-575e6a36></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-575e6a36><span class="visually-hidden" id="sidebar-aria-label" data-v-575e6a36> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="group" data-v-575e6a36><section class="VPSidebarItem level-0" data-v-575e6a36 data-v-93e7e794><!----><div class="items" data-v-93e7e794><!--[--><div class="VPSidebarItem level-1 is-link" data-v-93e7e794 data-v-93e7e794><div class="item" data-v-93e7e794><div class="indicator" data-v-93e7e794></div><a class="VPLink link link" href="/introduction.html" data-v-93e7e794><!--[--><p class="text" data-v-93e7e794>Introduction</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-93e7e794 data-v-93e7e794><div class="item" data-v-93e7e794><div class="indicator" data-v-93e7e794></div><a class="VPLink link link" href="/getting-started.html" data-v-93e7e794><!--[--><p class="text" data-v-93e7e794>Getting Started</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-93e7e794 data-v-93e7e794><div class="item" data-v-93e7e794><div class="indicator" data-v-93e7e794></div><a class="VPLink link link" href="/runtime-apis.html" data-v-93e7e794><!--[--><p class="text" data-v-93e7e794>Runtime APIs</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-93e7e794 data-v-93e7e794><div class="item" data-v-93e7e794><div class="indicator" data-v-93e7e794></div><a class="VPLink link link" href="/cli.html" data-v-93e7e794><!--[--><p class="text" data-v-93e7e794>CLI</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-93e7e794 data-v-93e7e794><div class="item" data-v-93e7e794><div class="indicator" data-v-93e7e794></div><a class="VPLink link link" href="/examples.html" data-v-93e7e794><!--[--><p class="text" data-v-93e7e794>Examples</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="group" data-v-575e6a36><section class="VPSidebarItem level-0 collapsible" data-v-575e6a36 data-v-93e7e794><div class="item" role="button" tabindex="0" data-v-93e7e794><div class="indicator" data-v-93e7e794></div><h2 class="text" data-v-93e7e794>Usage</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-93e7e794><span class="vpi-chevron-right caret-icon" data-v-93e7e794></span></div></div><div class="items" data-v-93e7e794><!--[--><div class="VPSidebarItem level-1 is-link" data-v-93e7e794 data-v-93e7e794><div class="item" data-v-93e7e794><div class="indicator" data-v-93e7e794></div><a class="VPLink link link" href="/usage/deployments.html" data-v-93e7e794><!--[--><p class="text" data-v-93e7e794>Deployments</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-93e7e794 data-v-93e7e794><div class="item" data-v-93e7e794><div class="indicator" data-v-93e7e794></div><a class="VPLink link link" href="/usage/assets.html" data-v-93e7e794><!--[--><p class="text" data-v-93e7e794>Assets</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-93e7e794 data-v-93e7e794><div class="item" data-v-93e7e794><div class="indicator" data-v-93e7e794></div><a class="VPLink link link" href="/usage/environment-variables.html" data-v-93e7e794><!--[--><p class="text" data-v-93e7e794>Environment variables</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-93e7e794 data-v-93e7e794><div class="item" data-v-93e7e794><div class="indicator" data-v-93e7e794></div><a class="VPLink link link" href="/usage/domains.html" data-v-93e7e794><!--[--><p class="text" data-v-93e7e794>Domains</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-93e7e794 data-v-93e7e794><div class="item" data-v-93e7e794><div class="indicator" data-v-93e7e794></div><a class="VPLink link link" href="/usage/logs.html" data-v-93e7e794><!--[--><p class="text" data-v-93e7e794>Logs</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-93e7e794 data-v-93e7e794><div class="item" data-v-93e7e794><div class="indicator" data-v-93e7e794></div><a class="VPLink link link" href="/usage/cron.html" data-v-93e7e794><!--[--><p class="text" data-v-93e7e794>Cron</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-93e7e794 data-v-93e7e794><div class="item" data-v-93e7e794><div class="indicator" data-v-93e7e794></div><a class="VPLink link link" href="/usage/limits.html" data-v-93e7e794><!--[--><p class="text" data-v-93e7e794>Limits</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-93e7e794 data-v-93e7e794><div class="item" data-v-93e7e794><div class="indicator" data-v-93e7e794></div><a class="VPLink link link" href="/usage/security.html" data-v-93e7e794><!--[--><p class="text" data-v-93e7e794>Security</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="group" data-v-575e6a36><section class="VPSidebarItem level-0 collapsible collapsed" data-v-575e6a36 data-v-93e7e794><div class="item" role="button" tabindex="0" data-v-93e7e794><div class="indicator" data-v-93e7e794></div><h2 class="text" data-v-93e7e794>Self hosting</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-93e7e794><span class="vpi-chevron-right caret-icon" data-v-93e7e794></span></div></div><div class="items" data-v-93e7e794><!--[--><div class="VPSidebarItem level-1 is-link" data-v-93e7e794 data-v-93e7e794><div class="item" data-v-93e7e794><div class="indicator" data-v-93e7e794></div><a class="VPLink link link" href="/self-hosting/installation.html" data-v-93e7e794><!--[--><p class="text" data-v-93e7e794>Installation</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-93e7e794 data-v-93e7e794><div class="item" data-v-93e7e794><div class="indicator" data-v-93e7e794></div><a class="VPLink link link" href="/self-hosting/configuration.html" data-v-93e7e794><!--[--><p class="text" data-v-93e7e794>Configuration</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-5d98c3a5 data-v-1428d186><div class="VPDoc has-sidebar has-aside" data-v-1428d186 data-v-39a288b8><!--[--><!--]--><div class="container" data-v-39a288b8><div class="aside" data-v-39a288b8><div class="aside-curtain" data-v-39a288b8></div><div class="aside-container" data-v-39a288b8><div class="aside-content" data-v-39a288b8><div class="VPDocAside" data-v-39a288b8 data-v-3f215769><!--[--><!--]--><!--[--><!--]--><div class="VPDocAsideOutline" role="navigation" data-v-3f215769 data-v-935f8a84><div class="content" data-v-935f8a84><div class="outline-marker" data-v-935f8a84></div><div class="outline-title" role="heading" aria-level="2" data-v-935f8a84>On this page</div><nav aria-labelledby="doc-outline-aria-label" data-v-935f8a84><span class="visually-hidden" id="doc-outline-aria-label" data-v-935f8a84> Table of Contents for current page </span><ul class="VPDocOutlineItem root" data-v-935f8a84 data-v-b933a997><!--[--><!--]--></ul></nav></div></div><!--[--><!--]--><div class="spacer" data-v-3f215769></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-39a288b8><div class="content-container" data-v-39a288b8><!--[--><!--]--><main class="main" data-v-39a288b8><div style="position:relative;" class="vp-doc _contributing" data-v-39a288b8><div><h1 id="contributing" tabindex="-1">Contributing <a class="header-anchor" href="#contributing" aria-label="Permalink to "Contributing""></a></h1><p>Thanks for wanting to contribute! That means a lot to us. You can contribute in many ways, with or without any coding required.</p><div class="info custom-block"><p class="custom-block-title">INFO</p><p>Need some good first issues to start with? Check out the <a href="https://github.com/lagossapp/lagoss/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22" target="_blank" rel="noreferrer">good first issue label</a> on GitHub!</p></div><h2 id="non-code-contributions" tabindex="-1">Non-code contributions <a class="header-anchor" href="#non-code-contributions" aria-label="Permalink to "Non-code contributions""></a></h2><h3 id="issues-and-community-help" tabindex="-1">Issues and community help <a class="header-anchor" href="#issues-and-community-help" aria-label="Permalink to "Issues and community help""></a></h3><p>Work in progress...</p><h3 id="documentation-website" tabindex="-1">Documentation website <a class="header-anchor" href="#documentation-website" aria-label="Permalink to "Documentation website""></a></h3><p>The documentation website is made of <a href="https://en.wikipedia.org/wiki/Markdown" target="_blank" rel="noreferrer">Markdown</a> files, located in <code>packages/docs/pages/</code>. It uses <a href="https://nextra.vercel.app/" target="_blank" rel="noreferrer">Nextra</a> behind the scenes.</p><p>If you want to preview your changes, you can run the documentation website locally. First, follow the <a href="#requirements">Requirements</a>, and then run <code>pnpm start:docs</code> at the root of the project. You can now access the documentation website on <code>localhost:3000</code>.</p><h2 id="code-contributions" tabindex="-1">Code contributions <a class="header-anchor" href="#code-contributions" aria-label="Permalink to "Code contributions""></a></h2><h3 id="coding-guidelines" tabindex="-1">Coding guidelines <a class="header-anchor" href="#coding-guidelines" aria-label="Permalink to "Coding guidelines""></a></h3><ul><li>Commits are following the <a href="https://www.conventionalcommits.org/en/v1.0.0/" target="_blank" rel="noreferrer">conventional commits</a> convention.</li><li>We use ESLint and Prettier to format our code, which should be handled automatically by most editors. If this is not the case, you can run the <code>lint</code> script.</li><li>Make sure to add a test when adding new features / fixing bugs, so we can prevent any other future bugs.</li></ul><h3 id="requirements" tabindex="-1">Requirements <a class="header-anchor" href="#requirements" aria-label="Permalink to "Requirements""></a></h3><p>You will need <a href="https://nodejs.org/en/" target="_blank" rel="noreferrer">Node.js</a> >= 16 and <a href="https://pnpm.io/" target="_blank" rel="noreferrer">PNPM</a> >= 7 (as of writing). You will also need <a href="https://www.docker.com/" target="_blank" rel="noreferrer">Docker</a> installed, and if you want to contribute to any Rust code, you will need <a href="https://www.rust-lang.org/" target="_blank" rel="noreferrer">Rust</a> >= 1.67 installed.</p><ol><li>Fork and clone the repository</li><li>Install all NPM dependencies: <code>pnpm install</code></li></ol><p>If you want to contribute to the Dashboard / Serverless / CLI:</p><ol start="3"><li><p>Run the local docker-compose: <code>docker-compose up -d</code></p></li><li><p>Copy <code>packages/dashboard/.env.example</code> to <code>packages/dashboard/.env</code>, and <code>crates/serverless/.env.example</code> to <code>crates/serverless/.env</code></p></li><li><p>Fill in the following environment variables:</p></li></ol><h5 id="in-packages-dashboard-env-and-crates-serverless-env" tabindex="-1">In <code>packages/dashboard/.env</code> and <code>crates/serverless/.env</code>: <a class="header-anchor" href="#in-packages-dashboard-env-and-crates-serverless-env" aria-label="Permalink to "In `packages/dashboard/.env` and `crates/serverless/.env`:""></a></h5><ul><li>(optional) <code>AXIOM_ORG_ID</code>, <code>AXIOM_TOKEN</code> to send and get logs to Axiom</li></ul><h5 id="in-packages-dashboard-env" tabindex="-1">In <code>packages/dashboard/.env</code>: <a class="header-anchor" href="#in-packages-dashboard-env" aria-label="Permalink to "In `packages/dashboard/.env`:""></a></h5><ul><li><code>NEXTAUTH_SECRET</code> is a random secret for <a href="https://authjs.dev/getting-started/oauth-tutorial#adding-environment-variables" target="_blank" rel="noreferrer">NextAuth.js</a>. Generate one using <code>$ openssl rand -base64 32</code></li><li>(optional) <code>GITHUB_CLIENT_ID</code>, <code>GITHUB_CLIENT_SECRET</code> are GitHub OAuth credentials. <a href="https://github.com/settings/developers" target="_blank" rel="noreferrer">Create a GitHub OAuth App</a></li><li>(optional) <code>GOOGLE_CLIENT_ID</code>, <code>GOOGLE_CLIENT_SECRET</code> are Google OAuth credentials. <a href="https://console.developers.google.com/apis/credentials" target="_blank" rel="noreferrer">Create a Google OAuth App</a></li><li>(optional) <code>SMTP_HOST</code>, <code>SMTP_PORT</code>, <code>SMTP_USER</code>, <code>SMTP_PASSWORD</code>, <code>SMTP_FROM</code> are SMTP credentials to send emails</li></ul><h4 id="www" tabindex="-1">www <a class="header-anchor" href="#www" aria-label="Permalink to "www""></a></h4><p>Navigate to <code>www</code> and run <code>pnpm dev</code> to start the website.</p><h4 id="ui" tabindex="-1">UI <a class="header-anchor" href="#ui" aria-label="Permalink to "UI""></a></h4><p>Navigate to <code>packages/ui</code> and run <code>pnpm dev</code> to start the Storybook server.</p><h4 id="dashboard" tabindex="-1">Dashboard <a class="header-anchor" href="#dashboard" aria-label="Permalink to "Dashboard""></a></h4><p>Navigate to <code>packages/dashboard</code> and run <code>pnpm prisma migrate dev</code> to generate the database tables. You can now start the dashboard using <code>pnpm dev</code>.</p><h4 id="js-runtime" tabindex="-1">JS Runtime <a class="header-anchor" href="#js-runtime" aria-label="Permalink to "JS Runtime""></a></h4><p>Navigate to <code>packages/js-runtime</code> and run <code>pnpm build</code> to build the JavaScript runtime. You can also run <code>pnpm dev</code> to watch for changes and automatically rebuild.</p><h4 id="serverless" tabindex="-1">Serverless <a class="header-anchor" href="#serverless" aria-label="Permalink to "Serverless""></a></h4><p>Make sure you've followed the <a href="#requirements">Requirements</a> and the <a href="#js-runtime">JS Runtime</a> setup.</p><p>Navigate to <code>crates/serverless</code> and run <code>cargo run</code> to start the Serverless process. You can also run <code>cargo test</code> at the root of the project to run all tests.</p><h4 id="cli" tabindex="-1">CLI <a class="header-anchor" href="#cli" aria-label="Permalink to "CLI""></a></h4><p>Make sure you've followed the <a href="#requirements">Requirements</a> and the <a href="#js-runtime">JS Runtime</a> setup.</p><p>Navigate to <code>crates/cli</code> and run <code>cargo run</code> to start the CLI. You can pass arguments to the CLI using <code>cargo run -- <args></code>. For example, <code>cargo run -- dev index.ts</code>.</p><h4 id="wpt-runner" tabindex="-1">WPT Runner <a class="header-anchor" href="#wpt-runner" aria-label="Permalink to "WPT Runner""></a></h4><p>Make sure you've followed the <a href="#requirements">Requirements</a> and the <a href="#js-runtime">JS Runtime</a> setup.</p><p>First, you'll need to update the WPT submodule. Navigate to <code>tools/wpt</code> and run <code>git submodule update --init</code>.</p><p>Then, navigate to <code>crates/wpt-runner</code> and run <code>cargo run</code> to start the WPT Runner. You can optionally pass a path to a specific file or directory to run the tests on. For example, <code>cargo run -- ../../tools/wpt/fetch/api/headers/header-setcookie.any.js</code></p><p>Every time you update the js-runtime code, you will need to rebuild it. We recommend running the <code>dev</code> script of js-runtime to watch for changes and automatically rebuild.</p><h3 id="before-submitting-a-pr" tabindex="-1">Before submitting a PR <a class="header-anchor" href="#before-submitting-a-pr" aria-label="Permalink to "Before submitting a PR""></a></h3><p>We have some checks in place to ensure we don't introduce bugs or regressions in PRs. You can run <code>pnpm lint</code> and <code>pnpm typecheck</code> at the project's root to ensure there are no lint and type errors.</p><p>Finally, run <code>pnpm changeset</code> to generate a <a href="https://github.com/changesets/changesets#how-do-we-do-that" target="_blank" rel="noreferrer">changeset file</a>. Select the modified packages and choose the SemVer increment "major", "minor", or "patch", then write a short description of the changes.</p></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-09de1c0f><!--[--><!--]--><!----><nav class="prev-next" data-v-09de1c0f><div class="pager" data-v-09de1c0f><!----></div><div class="pager" data-v-09de1c0f><a class="VPLink link pager-link next" href="/introduction.html" data-v-09de1c0f><!--[--><span class="desc" data-v-09de1c0f>Next page</span><span class="title" data-v-09de1c0f>Introduction</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"usage_account.md\":\"C9_xtxIe\",\"usage_logs.md\":\"CYi1T4oK\",\"self-hosting_installation.md\":\"DbP0ZG9Q\",\"usage_regions.md\":\"-dhRGrOk\",\"usage_assets.md\":\"C6GaJV4X\",\"usage_cron.md\":\"B3vI2t5q\",\"usage_deployments.md\":\"DrmzjEhc\",\"index.md\":\"BcD_NlRD\",\"usage_security.md\":\"li7Tnvjy\",\"usage_domains.md\":\"Dd091cC_\",\"contributing.md\":\"yZsRwz4D\",\"self-hosting_configuration.md\":\"C3WX_j5_\",\"usage_limits.md\":\"C0jqZFQy\",\"usage_pricing.md\":\"lJNWBUap\",\"runtime-apis.md\":\"jbG-txpu\",\"cli.md\":\"DQYfCWmm\",\"getting-started.md\":\"DgBv55-U\",\"usage_environment-variables.md\":\"DU_oi06y\",\"examples.md\":\"7Ptb0G4R\",\"introduction.md\":\"Ce0dD3Ro\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Lagoss\",\"description\":\"An open-source runtime and platform that allows developers to run TypeScript and JavaScript Serverless Functions.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"/icon-white.png\",\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Docs\",\"link\":\"/introduction\"}],\"sidebar\":[{\"text\":\"Introduction\",\"link\":\"/introduction\"},{\"text\":\"Getting Started\",\"link\":\"/getting-started\"},{\"text\":\"Runtime APIs\",\"link\":\"/runtime-apis\"},{\"text\":\"CLI\",\"link\":\"/cli\"},{\"text\":\"Examples\",\"link\":\"/examples\"},{\"text\":\"Usage\",\"collapsed\":false,\"items\":[{\"text\":\"Deployments\",\"link\":\"/usage/deployments\"},{\"text\":\"Assets\",\"link\":\"/usage/assets\"},{\"text\":\"Environment variables\",\"link\":\"/usage/environment-variables\"},{\"text\":\"Domains\",\"link\":\"/usage/domains\"},{\"text\":\"Logs\",\"link\":\"/usage/logs\"},{\"text\":\"Cron\",\"link\":\"/usage/cron\"},{\"text\":\"Limits\",\"link\":\"/usage/limits\"},{\"text\":\"Security\",\"link\":\"/usage/security\"}]},{\"text\":\"Self hosting\",\"collapsed\":true,\"items\":[{\"text\":\"Installation\",\"link\":\"/self-hosting/installation\"},{\"text\":\"Configuration\",\"link\":\"/self-hosting/configuration\"}]}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/lagossapp/lagoss\"}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
</body>
</html>