docs: book

This commit is contained in:
Ben Allfree
2023-06-10 04:23:01 -07:00
parent 84b0a7de04
commit ea3cb58cd0
13 changed files with 104 additions and 10 deletions

View File

@@ -0,0 +1,7 @@
# Backup & Restore
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).

7
gitbook/usage/create.md Normal file
View File

@@ -0,0 +1,7 @@
# Creating an Instance
Every PocketHost instance runs on a unique subdomain. To create a new instance, head to [https://pockethost.io/app/new](https://pockethost.io/app/new).
You'll need to choose a unique name.
That's literally all you need to do! Voila, a new PocketBase instance will now be available.

30
gitbook/usage/ftp.md Normal file
View File

@@ -0,0 +1,30 @@
# FTP Access
PocketHost allows you to access all your PocketBase files via Secure FTP (FTPS).
## Accessing via FTP
FTP to [ftp://pockethost.io](ftp://pockethost.io) and log in using your pockethost.io username and password.
The initial directory listing contains a directory for each instance associated with your account.
Inside each instance directory, you will find:
| Directory Name | Description |
| -------------- | ----------------------------------------------------------------------------- |
| pb_data | The PocketBase data directory |
| pb_static | The location from which static files are served |
| pb_migrations | The PocketBase [migrations](https://pocketbase.io/docs/migrations/) directory |
| worker | The Deno-based cloud worker |
## Recommended Clients
### GUI
- [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)]

9
gitbook/usage/help.md Normal file
View File

@@ -0,0 +1,9 @@
# Getting Help
## 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.
## Email
If you need to have a private conversation, contact ben@pockethost.io.

View File

@@ -0,0 +1,21 @@
# 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

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

View File

@@ -0,0 +1,7 @@
# Upgrading your Instance Version
PocketHost supports all versions of PocketBase.
Your instance uses [semver](https://semver.org/) to describe which version of PocketBase to run (eg, `~0.16.0`).
If you need to change the semver, please contact us.