mirror of
https://github.com/pockethost/pockethost.git
synced 2025-05-19 13:26:42 +00:00
chore: doc update
This commit is contained in:
parent
8c97524a70
commit
59e41cc005
@ -5,6 +5,8 @@ Your PocketBase instance managed by PocketHost is accessible in two ways:
|
|||||||
1. `<uuid>.pockethost.io`
|
1. `<uuid>.pockethost.io`
|
||||||
2. `<subdomain>.pockethost.io`
|
2. `<subdomain>.pockethost.io`
|
||||||
|
|
||||||
Every PocketHost instance is assigned a UUID that never changes. For 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 [./rename-instance.md](renamed), PocketHost also assigns a UUID that never changes. In this case, the UUID is `mfsicdp6ia1zpiu`. Thus, the instance permalink is `https://mfsicdp6ia1zpiu.pockethost.io`.
|
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`.
|
||||||
|
|
||||||
In the future, support for custom domains will be available. That is being tracked [here](https://github.com/benallfree/pockethost/issues/25).
|
In the future, support for custom domains will be available. That is being tracked [here](https://github.com/benallfree/pockethost/issues/25).
|
||||||
|
@ -13,7 +13,7 @@ You can start by creating `*.pb.js` file(s) inside the `pb_hooks` directory. The
|
|||||||
## Important Notes
|
## Important Notes
|
||||||
|
|
||||||
- Altering the `pb_hooks` directory will cause your PocketHost instance to be restarted so changes are picked up automatically.
|
- 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 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](./maintenance.md) until you can correct the problem and manually move your instance out of Maintenance Mode.
|
||||||
|
|
||||||
## Code Samples
|
## Code Samples
|
||||||
|
|
||||||
|
@ -16,6 +16,8 @@ Instances are placed in hibernation after 5 seconds of idle time.
|
|||||||
|
|
||||||
## Usage Metering
|
## Usage Metering
|
||||||
|
|
||||||
|
_Note: Usage Metering is not active until PocketHost reaches v1.0. There is no planned timeline for when or if PocketHost will reach v1.0_
|
||||||
|
|
||||||
The free tier of PocketHost provides 100 _active minutes_ per month.
|
The free tier of PocketHost provides 100 _active minutes_ per month.
|
||||||
|
|
||||||

|

|
||||||
|
@ -1,14 +1,18 @@
|
|||||||
# Maintenance Mode
|
# Maintenance Mode
|
||||||
|
|
||||||
Maintenance Mode will cause your PocketBase instance to shut down. The `pocketbase` process will exit and no further requests will be processed.
|
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.
|
||||||
|
|
||||||
|
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:
|
Maintenance Mode is helpful for the following tasks:
|
||||||
|
|
||||||
- Updating the version \[./upgrading.md]\(see upgrading)
|
- Updating the version [see upgrading](./upgrading.md)
|
||||||
- Backing up your data \[./backup-and-restore.md]\(see backing up and restoring)
|
- Backing up your data [see backing up and restoring](./backup-and-restore.md)
|
||||||
- Emergency shutdown for any other reason you choose.
|
- Emergency shutdown for any other reason you choose.
|
||||||
|
|
||||||
## Entering Maintenance Mode
|
## Manually Activating Maintenance Mode
|
||||||
|
|
||||||
To activate Maintenance Mode, navigate to your instance dashboard and head for the Danger Zone.
|
To activate Maintenance Mode, navigate to your instance dashboard and head for the Danger Zone.
|
||||||
|
|
||||||
@ -25,3 +29,5 @@ Then, switch the instance to Maintenance Mode.
|
|||||||
<figure><img src="maintenance-mode.png" alt="" width="350" border=1><figcaption><p>Maintenance Mode</p></figcaption></figure>
|
<figure><img src="maintenance-mode.png" alt="" width="350" border=1><figcaption><p>Maintenance Mode</p></figcaption></figure>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
##
|
||||||
|
Loading…
x
Reference in New Issue
Block a user