Marketing - Documentation Links & Image Updates (#305)

* Documentation Links & Image Updates

* Updated a letter in the docs
This commit is contained in:
Brewhouse Digital 2023-10-02 16:11:40 -05:00 committed by Ben Allfree
parent 95a48d7489
commit 7da58229a2
27 changed files with 39 additions and 68 deletions

View File

@ -4,7 +4,7 @@ category: development
subcategory: full-stack
---
If you can't use [dnsmasq](./dnsmasq.md) or equivalent, you can still configure hosts manually. The dev experience will be slightly more limited, but it will still work.
If you can't use [dnsmasq](/docs/development/full-stack/dnsmasq/) or equivalent, you can still configure hosts manually. The dev experience will be slightly more limited, but it will still work.
**1. Add host entries to `/etc./hosts`**
@ -12,7 +12,7 @@ If you can't use [dnsmasq](./dnsmasq.md) or equivalent, you can still configure
sudo nano /etc/hosts
```
Then, add these entires:
Then, add these entries:
```
127.0.0.1 pockethost.test # The main domain
@ -20,4 +20,4 @@ Then, add these entires:
127.0.0.1 test.pockethost.test # A sample (user) pocketbase instance
```
Add as many `*.pockethost.test` subdomains as you want to test. Since `/etc/hosts` does not support wildcarding, this must be done manually.
Add as many `*.pockethost.test` subdomains as you want to test. Since `/etc/hosts` does not support wild-carding, this must be done manually.

View File

@ -8,7 +8,7 @@ The entire pockethost.io stack can be run locally.
**Prerequisites**
- Local SSL wildcard domain - [local domain setup instructions](local-domain-setup.md)
- Local SSL wildcard domain - [local domain setup instructions](/docs/development/full-stack/local-domain-setup/)
**Running in dev mode**

View File

@ -33,7 +33,7 @@ For other browsers and operating systems, follow the instructions here: https://
**4. Configure your machine to recognize wildcard localhost domains.**
If you are on OS X, follow the [dnsmasq instructions](dnsmasq.md) to set up your local machine for the ultimate local domain wildcard dev experience.
If you are on OS X, follow the [dnsmasq instructions](/docs/development/full-stack/dnsmasq/) to set up your local machine for the ultimate local domain wildcard dev experience.
Remember to start `dnsmasq` every time:
@ -41,4 +41,4 @@ Remember to start `dnsmasq` every time:
brew services restart dnsmasq
```
If you don't want to use `dnsmasq`, follow the [manual /etc/hosts setup instructions](etc_hosts.md).
If you don't want to use `dnsmasq`, follow the [manual /etc/hosts setup instructions](/docs/development/full-stack/etc_hosts/).

View File

@ -3,11 +3,11 @@ title: Creating RPC Calls
category: development
---
For security, PocketHost does not allow modification of records by the frontend PocketBase client. Instead, the frontend must send an rpc request which the backend will securely process. This allows for many security vulnerabilities to be addressed which PocketBase admin security rules cannot. In particular, PocketBase admin security rules fall short in these scenarios:
For security, PocketHost does not allow modification of records by the frontend PocketBase client. Instead, the frontend must send an RPC request which the backend will securely process. This allows for many security vulnerabilities to be addressed which PocketBase admin security rules cannot. In particular, PocketBase admin security rules fall short in these scenarios:
- When the incoming data cannot be validated declaratively
- When multiple records and/or tables must be updated as a transaction
- When side-effects (ie, other mutations) are required under specific conditions
- When side effects (ie, other mutations) are required under specific conditions
Therefore, PocketHost uses an RPC pattern instead.

View File

@ -7,13 +7,13 @@ category: getting-started
### Overview
PocketHost ([https://pockethost.io](https://pockethost.io)) hosts your [PocketBase](https://pocketbase.io) projects so you don't have to. Create a project like you would in Firebase and Supabase and let PocketHost do the rest.
PocketHost hosts your [PocketBase](https://pocketbase.io) projects, so you don't have to. Create a project like you would in Firebase and Supabase and let PocketHost do the rest.
PocketHost is a cloud hosting platform for PocketBase. You can use it to instantly provision a PocketBase backend for your latest project. Features include:
- Create unlimited PocketBase projects, each with a custom subdomain
- Each instance runs on a subdomain of `pockethost.io`
- Access your PocketBase instance using the PocketBase JavaScript SDK as easily as new `PocketBase('https://my-project.pockethost.io')`
- Access your PocketBase instance using the PocketBase JavaScript SDK as easily as `new PocketBase('https://my-project.pockethost.io')`
- Run your instance in an ultra-beefy shared environment
### Focus on your app
@ -25,6 +25,8 @@ Get a live PocketBase instance in 10 seconds with no backend setup:
3. Connect from anywhere
```ts
import PocketBase from 'pocketbase';
const client = new PocketBase(`https://harvest.pockethost.io`)
```

View File

@ -7,9 +7,9 @@ category: getting-started
### What is pockethost.io?
https://pockethost.io is a nonprofit hosting service powered by the PocketHost open source project. Also created and run by benallfree.
https://pockethost.io is a nonprofit hosting service powered by the PocketHost open source project. Also created and run by `benallfree`.
[PocketHost](https://github.com/benallfree/pockethost) is an open source project licensed under the MIT open source license. It was created and is headed by [benallfree](https://github.com/benallfree). He made PocketHost to host his personal and client projects so it was easy to provision a new PocketBase instance without having to set up any servers.
[PocketHost](https://github.com/benallfree/pockethost) is an open source project licensed under the MIT open source license. It was created and is headed by [benallfree](https://github.com/benallfree). He made PocketHost to host his personal and client projects, so it was easy to provision a new PocketBase instance without having to set up any servers.
The goal of the project is to create a Firebase/Supabase style experience where you can create an account and instantly provision a new PocketBase instance for yourself.
@ -21,7 +21,7 @@ Hopefully, PocketHost provides a turnkey solution for creating and deploying sma
PocketHost was created as a service to the PocketBase community because we love the sovereignty principle of PocketBase, but also dont always want to self host.
The features and priorities in development are balanced between benallfree's personal needs and things requested by the community.
The features and priorities in development are balanced between `benallfree`'s personal needs and things requested by the community.
PocketHost has a 10-year endowment to offer a free tier of hosting for hobby projects and low to mid-volume projects.
@ -51,7 +51,7 @@ You can also back up and download all your data at any time. Access your own dat
### Can I import data into PocketHost?
Yes, [via FTP](../usage/ftp.md).
Yes, [via FTP](/docs/usage/ftp/).
### How do I migrate away from PocketHost and host PocketBase on my own?
@ -92,7 +92,7 @@ pockethost.io offers a one-size-fits-all paid plan. The paid plan includes:
### What happens when I reach my minutes / rate / something?
Your instance will be placed into [Maintenance Mode](../daily-usage/maintenance-mode) until the problem is corrected.
Your instance will be placed into [Maintenance Mode](/docs/usage/maintenance/) until the problem is corrected.
### Are we allowed to have multiple projects running on Pockethost? How many instances can I create?

View File

@ -5,7 +5,7 @@ category: getting-started
## Discussion Forum
The fastest and easiest way to get help is to head over to the [PocketHost Discussions](https://github.com/benallfree/pockethost/discussions) forum. Please do not create github issues without initiating a discussion first.
The fastest and easiest way to get help is to head over to the [PocketHost Discussions](https://github.com/benallfree/pockethost/discussions) forum. Please do not create GitHub issues without initiating a discussion first.
## Email

View File

@ -1,17 +0,0 @@
---
title: This is my second post with a much longer title.
description: This is a post on My Blog about leveraging agile frameworks.
date: 2018-07-04
tags:
- number 2
---
Leverage agile frameworks to provide a robust synopsis for high level overviews. Iterative approaches to corporate strategy foster collaborative thinking to further the overall value proposition. Organically grow the holistic world view of disruptive innovation via workplace diversity and empowerment.
## Section Header
<a href="/blog/firstpost/">First post</a>
<a href="/blog/thirdpost/">Third post</a>
Bring to the table win-win survival strategies to ensure proactive domination. At the end of the day, going forward, a new normal that has evolved from generation X is on the runway heading towards a streamlined cloud solution. User generated content in real-time will have multiple touchpoints for offshoring.
Capitalize on low hanging fruit to identify a ballpark value added activity to beta test. Override the digital divide with additional clickthroughs from DevOps. Nanotechnology immersion along the information highway will close the loop on focusing solely on the bottom line.

View File

@ -10,6 +10,6 @@ Your PocketBase instance managed by PocketHost is accessible in two ways:
Every PocketHost instance is assigned a UUID that never changes, and a unique subdomain that you control and can change at any time.
> Example: I use PocketHost to run the backend for my web game named Harvest. I created a PocketHost instance and chose the name `harvest`. This is unique across all of PocketHost, and I can access my instance at `https://harvest.pockethost.io`. However, because instances can be [renamed](./rename-instance.md), PocketHost also assigns a UUID that never changes. In this case, the UUID is `mfsicdp6ia1zpiu`. Thus, the instance permalink is `https://mfsicdp6ia1zpiu.pockethost.io`.
> Example: I use PocketHost to run the backend for my web game named Harvest. I created a PocketHost instance and chose the name `harvest`. This is unique across all of PocketHost, and I can access my instance at `https://harvest.pockethost.io`. However, because instances can be [renamed](/docs/usage/rename-instance/), PocketHost also assigns a UUID that never changes. In this case, the UUID is `mfsicdp6ia1zpiu`. Thus, the instance permalink is `https://mfsicdp6ia1zpiu.pockethost.io`.
In the future, support for custom domains will be available. That is being tracked [here](https://github.com/benallfree/pockethost/issues/25).

View File

@ -3,11 +3,11 @@ title: Backup & Restore
category: usage
---
You can use [FTP](ftp.md) to perform backup and restore operations.
You can use [FTP](/docs/usage/ftp/) to perform backup and restore operations.
## Before you Begin
Make sure your PocketHost instance status is [idle](./instance-details/index.md).
Make sure your PocketHost instance status is [idle](/docs/usage/instances/#on-demand-execution).
## Backing Up

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

View File

@ -16,7 +16,7 @@ You can start by creating `*.pb.js` file(s) inside the `pb_hooks` directory. The
## Important Notes
- Altering the `pb_hooks` directory will cause your PocketHost instance to be restarted so changes are picked up automatically.
- If code in `pb_hooks` causes your `pocketbase` instance to exit unexpectedly, your instance will be placed in [Maintenance Mode](./maintenance.md) until you can correct the problem and manually move your instance out of Maintenance Mode.
- If code in `pb_hooks` causes your `pocketbase` instance to exit unexpectedly, your instance will be placed in [Maintenance Mode](/docs/usage/maintenance/) until you can correct the problem and manually move your instance out of Maintenance Mode.
## Code Samples

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

View File

@ -12,9 +12,7 @@ PocketHost runs your PocketBase instance on-demand. That means PocketHost waits
Instances are placed in hibernation after 5 seconds of idle time.
![](2023-01-05-22-22-47.png)
![](2023-01-05-22-21-17.png)
![View of an instance in the Idle state](/docs/instance-idle-screenshot.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.
@ -24,7 +22,7 @@ _Note: Usage Metering is not active until PocketHost reaches v1.0. There is no p
The free tier of PocketHost provides 100 _active minutes_ per month.
![](2023-01-05-23-02-49.png)
![View of an instance showing the total usage](/docs/instance-usage-screenshot.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.
@ -32,7 +30,7 @@ The free tier of PocketHost provides 100 _active minutes_ per month.
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.
![](2023-01-05-22-03-18.png)
![View of an instance showing the which version of PocketBase it is running](/docs/instance-version-screenshot.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.
@ -58,3 +56,5 @@ $app.getEnv('FOO')
```
## Realtime log
Coming Soon

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

View File

@ -5,34 +5,20 @@ category: usage
Maintenance Mode will prevent your instances `pocketbase` process from running. No requests are processed while your instance is in Maintenance Mode.
Maintenance mode can be activated manually, or PocketHost may place your instance in maintenance mode if it detects that the instance is malfunctining.
Maintenance mode can be activated manually, or PocketHost may place your instance in maintenance mode if it detects that the instance is malfunctioning.
If your `pocketbase` process exits unexpectedly for any reason, PocketHost will place your instance in Maintenance Mode. This automatic action will cause your PocketBase instance to shut down. The `pocketbase` process will exit and no further requests will be processed.
Maintenance Mode is helpful for the following tasks:
- Updating the version [see upgrading](./upgrading.md)
- Backing up your data [see backing up and restoring](./backup-and-restore.md)
- Updating the version [see upgrading](/docs/usage/upgrading/)
- Backing up your data [see backing up and restoring](/docs/usage/backup-and-restore/)
- Emergency shutdown for any other reason you choose.
## Manually Activating Maintenance Mode
To activate Maintenance Mode, navigate to your instance dashboard and head for the Danger Zone.
<div align="left">
![Danger Zone](../usage/danger-zone.png)
<figure><img src={DangerZone.src} alt="" width="350" border=1><figcaption><p>Danger Zone</p></figcaption></figure>
</div>
To activate Maintenance Mode, navigate to your instance dashboard and scroll to the bottom to see the "Danger Zone".
Then, switch the instance to Maintenance Mode.
<div align="left" data-full-width="false">
<figure><img src="maintenance-mode.png" alt="" width="350" border=1><figcaption><p>Maintenance Mode</p></figcaption></figure>
</div>
##
![Maintenance Mode](/docs/maintenance-mode-screenshot.png)

View File

@ -11,24 +11,24 @@ You may change this using the Danger Zone in the instance details.
## Automatic Upgrade Steps (most cases)
1. [Back up your instance](./backup-and-restore.md)
1. [Back up your instance](/docs/usage/backup-and-restore/)
2. Change to the new version you want. Typically, it is safe to use `~` in front, which will auto-upgrade any patch release. For example, if the current version of PocketBase is `0.16.5`, then specifying a semver range of `~0.16.0` will match `0.16.6` when it is released, but will not match `0.17.0` when it is released. For now, locking to the minor version is advised until PocketBase reaches v1.0.
3. Take your instance out of [maintenance mode](./maintenance.md) so it is once again live.
3. Take your instance out of [maintenance mode](/docs/usage/maintenance/) so it is once again live.
## Manual Upgrade Steps (rare)
Sometimes, the automated upgrade is not possible or may leave your PocketHost instance in an unresponsive state because PocketBase exits when it notices a problem with the database schema. In that case, you must perform a manual upgrade.
1. [Back up your instance](./backup-and-restore.md)
2. Put the instance in [Maintenance Mode](./maintenance.md)
1. [Back up your instance](/docs/usage/backup-and-restore/)
2. Put the instance in [Maintenance Mode](/docs/usage/maintenance/)
3. Update your instance to the target version you want.
4. Download your database via [FTP](./ftp.md)
4. Download your database via [FTP](/docs/usage/ftp/)
5. On your local machine, perform whatever upgrade steps are necessary according to the PocketBase documentation
6. Upload your database via FTP again
7. Take the instance out of Maintenance Mode and test
## Caveats
- Downgrading to an earlier version may work in some cases, but is not advised. See (#271)[https://github.com/pocketbase/pocketbase/discussions/2710#discussioncomment-6185502] for further details.
- Downgrading to an earlier version may work in some cases, but is not advised. See [#271](https://github.com/pocketbase/pocketbase/discussions/2710#discussioncomment-6185502) for further details.
- In some cases, you may need to
- When a new version of PocketHost is run for the first time, it may run migrations on its system tables. These migrations are typically non-destructive

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB