diff --git a/gitbook/SUMMARY.md b/gitbook/SUMMARY.md index 7bfc0c46..5de69506 100644 --- a/gitbook/SUMMARY.md +++ b/gitbook/SUMMARY.md @@ -1,56 +1,56 @@ # Table of contents -- [👋 Welcome to PocketHost](README.md) +* [👋 Welcome to PocketHost](README.md) ## Overview -- [Getting Help](overview/help.md) -- [FAQ](overview/faq.md) -- [Roadmap](overview/roadmap.md) +* [Getting Help](overview/help.md) +* [FAQ](overview/faq.md) +* [Roadmap](overview/roadmap.md) ## Daily Usage -- [Creating an Instance](usage/create.md) -- [Accessing an Instance](usage/accessing-instance.md) -- [Instance Details](usage/instances/index.md) -- [Renaming an Instance](usage/rename-instance.md) -- [Maintenance Mode](usage/maintenance.md) -- [FTP Access](usage/ftp.md) -- [Backup & Restore](usage/backup-and-restore.md) -- [Worker](usage/worker.md) -- [PocketBase Hooks](usage/hooks.md) -- [Upgrading](usage/upgrading.md) +* [Creating an Instance](usage/create.md) +* [Accessing an Instance](usage/accessing-instance.md) +* [Instance Details](usage/instances/index.md) +* [Renaming an Instance](usage/rename-instance.md) +* [Maintenance Mode](usage/maintenance.md) +* [FTP Access](usage/ftp.md) +* [Backup & Restore](usage/backup-and-restore.md) +* [Worker](daily-usage/worker.md) +* [PocketBase Hooks](usage/hooks.md) +* [Upgrading](usage/upgrading.md) ## Contributing -- [Overview](development/overview.md) -- [Running Just the Frontend](development/frontend.md) -- [Running Everything](development/full-stack/index.md) -- [Creating RPC Calls](development/rpc.md) -- [Production Deployment](development/production.md) +* [Overview](development/overview.md) +* [Running Just the Frontend](development/frontend.md) +* [Running Everything](development/full-stack/index.md) +* [Creating RPC Calls](development/rpc.md) +* [Production Deployment](development/production.md) ## Release History -- [next](releases/next.md) -- [0.8.0](releases/0.8.0.md) -- [0.7.2](releases/0.7.2.md) -- [0.7.1](releases/0.7.1.md) -- [0.7.0](releases/0.7.0.md) -- [0.6.1](releases/0.6.1.md) -- [0.6.0](releases/0.6.0.md) -- [0.5.7](releases/0.5.7.md) -- [0.5.6](releases/0.5.6.md) -- [0.5.5](releases/0.5.5.md) -- [0.5.4](releases/0.5.4.md) -- [0.5.3](releases/0.5.3.md) -- [0.5.2](releases/0.5.2.md) -- [0.5.1](releases/0.5.1.md) -- [0.5.0](releases/0.5.0.md) -- [0.4.2](releases/0.4.2.md) -- [0.4.1](releases/0.4.1.md) -- [0.4.0](releases/0.4.0.md) -- [0.3.2](releases/0.3.2.md) -- [0.3.1](releases/0.3.1.md) -- [0.3.0](releases/0.3.0.md) -- [0.2.0](releases/0.2.0.md) -- [0.0.1](release-history/0.0.1.md) +* [next](releases/next.md) +* [0.8.0](releases/0.8.0.md) +* [0.7.2](releases/0.7.2.md) +* [0.7.1](releases/0.7.1.md) +* [0.7.0](releases/0.7.0.md) +* [0.6.1](releases/0.6.1.md) +* [0.6.0](releases/0.6.0.md) +* [0.5.7](releases/0.5.7.md) +* [0.5.6](releases/0.5.6.md) +* [0.5.5](releases/0.5.5.md) +* [0.5.4](releases/0.5.4.md) +* [0.5.3](releases/0.5.3.md) +* [0.5.2](releases/0.5.2.md) +* [0.5.1](releases/0.5.1.md) +* [0.5.0](releases/0.5.0.md) +* [0.4.2](releases/0.4.2.md) +* [0.4.1](releases/0.4.1.md) +* [0.4.0](releases/0.4.0.md) +* [0.3.2](releases/0.3.2.md) +* [0.3.1](releases/0.3.1.md) +* [0.3.0](releases/0.3.0.md) +* [0.2.0](releases/0.2.0.md) +* [0.0.1](release-history/0.0.1.md) diff --git a/gitbook/usage/worker.md b/gitbook/daily-usage/worker.md similarity index 60% rename from gitbook/usage/worker.md rename to gitbook/daily-usage/worker.md index 1f4c80bc..1afe345d 100644 --- a/gitbook/usage/worker.md +++ b/gitbook/daily-usage/worker.md @@ -1,13 +1,13 @@ -# Cloud Worker +# Worker 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.md). +Update your Deno worker via [PocketHost's FTP service](../usage/ftp.md). ## Quickstart ## RPC system -- Install RPC schema -- add command names to filter table -- +* Install RPC schema +* add command names to filter table +* diff --git a/gitbook/release-history/0.0.1.md b/gitbook/release-history/0.0.1.md new file mode 100644 index 00000000..64312a4f --- /dev/null +++ b/gitbook/release-history/0.0.1.md @@ -0,0 +1,2 @@ +# 0.0.1 + diff --git a/gitbook/usage/ftp.md b/gitbook/usage/ftp.md index c8e9282c..4b0ca38c 100644 --- a/gitbook/usage/ftp.md +++ b/gitbook/usage/ftp.md @@ -12,20 +12,20 @@ Inside each instance directory, you will find: | Directory Name | Description | Instructions | | -------------- | ----------------------------------------------- | ------------------------------------------------------- | -| pb_data | The PocketBase data directory | [view](https://pocketbase.io/docs/going-to-production/) | -| pb_public | The location from which public files are served | [view](https://pocketbase.io/docs) | -| pb_migrations | The PocketBase migrations directory | [view](https://pocketbase.io/docs/migrations/) | -| pb_hooks | The PocketBase JS hooks directory | [view](https://pocketbase.io/docs/js-overview/) | -| worker | The Deno-based cloud worker | [view](./worker.md) | +| pb\_data | The PocketBase data directory | [view](https://pocketbase.io/docs/going-to-production/) | +| pb\_public | The location from which public files are served | [view](https://pocketbase.io/docs) | +| pb\_migrations | The PocketBase migrations directory | [view](https://pocketbase.io/docs/migrations/) | +| pb\_hooks | The PocketBase JS hooks directory | [view](https://pocketbase.io/docs/js-overview/) | +| worker | The Deno-based cloud worker | [view](../daily-usage/worker.md) | ## Recommended Clients ### GUI -- [FileZilla](https://filezilla-project.org/) is a great GUI frontend available for all platforms. +* [FileZilla](https://filezilla-project.org/) is a great GUI frontend available for all platforms. ### CLI -- [ftp](https://ftp.gnu.org/) -- [wget](https://www.gnu.org/software/wget/) [[homebrew](https://formulae.brew.sh/formula/wget)] -- [lftp](https://lftp.yar.ru/) [[homebrew](https://formulae.brew.sh/formula/lftp)] +* [ftp](https://ftp.gnu.org/) +* [wget](https://www.gnu.org/software/wget/) \[[homebrew](https://formulae.brew.sh/formula/wget)] +* [lftp](https://lftp.yar.ru/) \[[homebrew](https://formulae.brew.sh/formula/lftp)] diff --git a/gitbook/usage/instances/index.md b/gitbook/usage/instances/index.md index c9d67e57..778f01b2 100644 --- a/gitbook/usage/instances/index.md +++ b/gitbook/usage/instances/index.md @@ -1,4 +1,4 @@ -# Managing your Instance +# Instance Details PocketHost provides a simple dashboard where you can manage your instance. @@ -44,7 +44,7 @@ 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](../cloud.md) 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](broken-reference) 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') || ''