diff --git a/gitbook/SUMMARY.md b/gitbook/SUMMARY.md index e3ec9bac..50f1537a 100644 --- a/gitbook/SUMMARY.md +++ b/gitbook/SUMMARY.md @@ -5,13 +5,15 @@ ## Daily Usage - [Getting Help](usage/help.md) +- [FAQ](usage/faq.md) - [Creating an Instance](usage/create.md) - [Instance Details](usage/instance-details/index.md) - [FTP Access](usage/ftp.md) - [Backup & Restore](usage/backup-and-restore.md) +- [Cloud Functions](usage/cloud.md) - [Upgrading](usage/upgrading.md) -## Development +## Contributing - [Overview](development/overview.md) - [Roadmap](development/roadmap.md) diff --git a/gitbook/usage/backup-and-restore.md b/gitbook/usage/backup-and-restore.md index 6ba02fdd..8f919b00 100644 --- a/gitbook/usage/backup-and-restore.md +++ b/gitbook/usage/backup-and-restore.md @@ -5,3 +5,9 @@ You can use [FTP](ftp.md) to perform backup and restore operations. ## Before you Begin Make sure your PocketHost instance status is [idle](instance-details/index.md). + +## Backing Up + +## Restoring + +## Synchronizing diff --git a/packages/pockethost.io/src/docs/cloud_functions.md b/gitbook/usage/cloud.md similarity index 72% rename from packages/pockethost.io/src/docs/cloud_functions.md rename to gitbook/usage/cloud.md index 3c374274..8dae0c28 100644 --- a/packages/pockethost.io/src/docs/cloud_functions.md +++ b/gitbook/usage/cloud.md @@ -1,13 +1,8 @@ ---- -title: Cloud Functions -published: false ---- - # Cloud Functions PocketHost can run a Deno worker alongside your instance. In this worker, you can use the PocketHost client to listen for realtime changes or perform any other operations you desire. -Update your Deno worker via [PocketHost's FTP service](ftp). +Update your Deno worker via [PocketHost's FTP service](ftp.md). ## Quickstart diff --git a/packages/pockethost.io/src/docs/faq.md b/gitbook/usage/faq.md similarity index 99% rename from packages/pockethost.io/src/docs/faq.md rename to gitbook/usage/faq.md index cefb12ec..b9e63d4d 100644 --- a/packages/pockethost.io/src/docs/faq.md +++ b/gitbook/usage/faq.md @@ -1,8 +1,3 @@ ---- -title: FAQ -published: false ---- - # Frequently Asked Questions ## About diff --git a/gitbook/usage/instance-details/index.md b/gitbook/usage/instance-details/index.md deleted file mode 100644 index 1b349128..00000000 --- a/gitbook/usage/instance-details/index.md +++ /dev/null @@ -1,21 +0,0 @@ -# Instance Details - -## Status - -The instance status indicates whether the instance is currently running. Values might include `idle`, `starting`, and `running`. - -![Status](status.png) - -## Usage - -## Version - -## Admin URL - -## FTP access - -## Code samples - -## Secrets - -## Logs diff --git a/packages/pockethost.io/static/images/docs/2023-01-05-22-03-18.png b/gitbook/usage/instances/2023-01-05-22-03-18.png similarity index 100% rename from packages/pockethost.io/static/images/docs/2023-01-05-22-03-18.png rename to gitbook/usage/instances/2023-01-05-22-03-18.png diff --git a/packages/pockethost.io/static/images/docs/2023-01-05-22-20-30.png b/gitbook/usage/instances/2023-01-05-22-20-30.png similarity index 100% rename from packages/pockethost.io/static/images/docs/2023-01-05-22-20-30.png rename to gitbook/usage/instances/2023-01-05-22-20-30.png diff --git a/packages/pockethost.io/static/images/docs/2023-01-05-22-21-17.png b/gitbook/usage/instances/2023-01-05-22-21-17.png similarity index 100% rename from packages/pockethost.io/static/images/docs/2023-01-05-22-21-17.png rename to gitbook/usage/instances/2023-01-05-22-21-17.png diff --git a/packages/pockethost.io/static/images/docs/2023-01-05-22-22-47.png b/gitbook/usage/instances/2023-01-05-22-22-47.png similarity index 100% rename from packages/pockethost.io/static/images/docs/2023-01-05-22-22-47.png rename to gitbook/usage/instances/2023-01-05-22-22-47.png diff --git a/packages/pockethost.io/static/images/docs/2023-01-05-23-02-49.png b/gitbook/usage/instances/2023-01-05-23-02-49.png similarity index 100% rename from packages/pockethost.io/static/images/docs/2023-01-05-23-02-49.png rename to gitbook/usage/instances/2023-01-05-23-02-49.png diff --git a/packages/pockethost.io/src/docs/instances.md b/gitbook/usage/instances/index.md similarity index 70% rename from packages/pockethost.io/src/docs/instances.md rename to gitbook/usage/instances/index.md index b52b12f9..c9d67e57 100644 --- a/packages/pockethost.io/src/docs/instances.md +++ b/gitbook/usage/instances/index.md @@ -1,8 +1,3 @@ ---- -title: Managing Your Instance -published: true ---- - # Managing your Instance PocketHost provides a simple dashboard where you can manage your instance. @@ -13,9 +8,9 @@ PocketHost runs your PocketBase instance on-demand. That means PocketHost waits Instances are placed in hibernation after 5 seconds of idle time. -![](/images/docs/2023-01-05-22-22-47.png) +![](2023-01-05-22-22-47.png) -![](/images/docs/2023-01-05-22-21-17.png) +![](2023-01-05-22-21-17.png) > Note: There is a slight "first hit" penalty if PocketHost needs to spin up your idle instance before responding to a request. In practice, this is not noticeable to most users for most applications. It's nearly indistinguishable from normal network delays. @@ -23,15 +18,15 @@ Instances are placed in hibernation after 5 seconds of idle time. The free tier of PocketHost provides 100 _active minutes_ per month. -![](/images/docs/2023-01-05-23-02-49.png) +![](2023-01-05-23-02-49.png) -Because an instance stays active for a minimum of only 5 seconds per activation, 100 minutes of real, active usage is actually quite a bit. After you use your 100 minutes, you can either pay for more usage minutes, or PocketHost will move your instance to the pool of stand-by instances that get served after everyone else. Again, in practice, you will likely not even notice the difference. But if you do, there is always a paid option. +> Because an instance stays active for a minimum of only 5 seconds per activation, 100 minutes of real, active usage is actually quite a bit. After you use your 100 minutes, you can either pay for more usage minutes, or PocketHost will move your instance to the pool of stand-by instances that get served after everyone else. Again, in practice, you will likely not even notice the difference. But if you do, there is always a paid option. ## Instance Versioning By default, your instance will use the latest major+minor release of PocketBase. The PocketBase version is locked when your instance is created. We use [semver](https://semver.org/) ([npm package](https://docs.npmjs.com/cli/v6/using-npm/semver)) to determine the version range that should be allowed for your instance. When your instance is launched, it will use the latest matching version. -![](/images/docs/2023-01-05-22-03-18.png) +![](2023-01-05-22-03-18.png) For example, if the latest version of PocketBase is `0.10.4`, your instance will automatically run with `~0.10.4`, meaning that `major=0` and `minor=10` are locked, but `patch=4 or higher` will be applied. @@ -49,12 +44,10 @@ The PocketHost dashboard also provides a handy link to do this. ## Secrets -Instance secrets are defined as environment variables when a [PocketHost Cloud Function Deno worker](worker) is launched. Every secret you specify here will be made available as an environment variable to the Deno process: +Instance secrets are defined as environment variables when a [PocketHost Cloud Function Deno worker](../cloud.md) is launched. Every secret you specify here will be made available as an environment variable to the Deno process: ```ts const MY_SECRET = Deno.env.get('MY_SECRET') || '' ``` ## Realtime log - -## Backups and restores diff --git a/gitbook/usage/instance-details/status.png b/gitbook/usage/instances/status.png similarity index 100% rename from gitbook/usage/instance-details/status.png rename to gitbook/usage/instances/status.png diff --git a/packages/pockethost.io/src/components/Navbar.svelte b/packages/pockethost.io/src/components/Navbar.svelte index 47f556e6..0b0720f7 100644 --- a/packages/pockethost.io/src/components/Navbar.svelte +++ b/packages/pockethost.io/src/components/Navbar.svelte @@ -82,7 +82,7 @@
  • FAQ @@ -99,7 +99,7 @@
  • Docs diff --git a/packages/pockethost.io/src/docs/ftp.md b/packages/pockethost.io/src/docs/ftp.md deleted file mode 100644 index 69ae52b8..00000000 --- a/packages/pockethost.io/src/docs/ftp.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: FTP Access to Instances -published: false ---- - -# FTP Access to Instances - -PocketHost allows you to access your instance data, Deno workers, and static assets via FTP. - -## Accessing FTP - -## `pb_data` directory - -`pb_data` contains all the standard PocketBase data files. `instance_logs.db` - -## `pb_public` directory - -## `worker` directory - -```bash -ftp .pockethost.io -``` - -```ts -import cloud_functions from './cloud_functions.md' -import ftp from './ftp.md' -import introduction from './introduction.md' - -export type PageName = keyof typeof pages -export const pages = { introduction, cloud_functions, ftp } - -console.log(pages) -``` - -Log in using your PocketHost username and password. diff --git a/packages/pockethost.io/src/docs/index.ts b/packages/pockethost.io/src/docs/index.ts deleted file mode 100644 index 1c9b2a46..00000000 --- a/packages/pockethost.io/src/docs/index.ts +++ /dev/null @@ -1,10 +0,0 @@ -import cloud_functions from './cloud_functions.md' -import faq from './faq.md' -import ftp from './ftp.md' -import instances from './instances.md' -import introduction from './introduction.md' - -console.log(JSON.stringify(faq, null, 2)) -export type PageName = keyof typeof pages -export const pages = { introduction, instances, cloud_functions, ftp, faq } -export { faq, ftp, instances, introduction } diff --git a/packages/pockethost.io/src/docs/introduction.md b/packages/pockethost.io/src/docs/introduction.md deleted file mode 100644 index 1c7e4c63..00000000 --- a/packages/pockethost.io/src/docs/introduction.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Introduction -published: true ---- - -# PocketHost Docs - -Welcome to PocketHost! - -PocketHost is the zero-config, up-in-30-seconds hosting platform for PocketBase. If you're looking for a developer and production experience more like Firebase and Supabase, you've come to the right place. diff --git a/packages/pockethost.io/src/routes/docs/+layout.svelte b/packages/pockethost.io/src/routes/docs/+layout.svelte deleted file mode 100644 index a331340f..00000000 --- a/packages/pockethost.io/src/routes/docs/+layout.svelte +++ /dev/null @@ -1,48 +0,0 @@ - - -
    -
    -
    - {#each Object.entries(pages).filter(([k, p]) => p.attributes.published || PUBLIC_DEBUG) as [v, k], i} - - {/each} -
    -
    - -
    -
    -
    - - diff --git a/packages/pockethost.io/src/routes/docs/+page.svelte b/packages/pockethost.io/src/routes/docs/+page.svelte deleted file mode 100644 index 7dd36db7..00000000 --- a/packages/pockethost.io/src/routes/docs/+page.svelte +++ /dev/null @@ -1,9 +0,0 @@ - - -{@html md.body} diff --git a/packages/pockethost.io/src/routes/docs/[pageName]/+page.svelte b/packages/pockethost.io/src/routes/docs/[pageName]/+page.svelte deleted file mode 100644 index 85a7318f..00000000 --- a/packages/pockethost.io/src/routes/docs/[pageName]/+page.svelte +++ /dev/null @@ -1,23 +0,0 @@ - - -{#if !md.attributes.published} -
    Draft
    -{/if} -{@html md.body} diff --git a/packages/pockethost.io/src/routes/faq/+page.svelte b/packages/pockethost.io/src/routes/faq/+page.svelte deleted file mode 100644 index 55a7dc12..00000000 --- a/packages/pockethost.io/src/routes/faq/+page.svelte +++ /dev/null @@ -1,14 +0,0 @@ - - -
    -

    Frequently asked questions

    - -
    - -