mirror of
https://github.com/pockethost/pockethost.git
synced 2026-03-22 16:13:38 +00:00
docs: book
This commit is contained in:
7
gitbook/usage/backup-and-restore.md
Normal file
7
gitbook/usage/backup-and-restore.md
Normal 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
7
gitbook/usage/create.md
Normal 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
30
gitbook/usage/ftp.md
Normal 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
9
gitbook/usage/help.md
Normal 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.
|
||||
21
gitbook/usage/instance-details/index.md
Normal file
21
gitbook/usage/instance-details/index.md
Normal 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`.
|
||||
|
||||

|
||||
|
||||
## Usage
|
||||
|
||||
## Version
|
||||
|
||||
## Admin URL
|
||||
|
||||
## FTP access
|
||||
|
||||
## Code samples
|
||||
|
||||
## Secrets
|
||||
|
||||
## Logs
|
||||
BIN
gitbook/usage/instance-details/status.png
Normal file
BIN
gitbook/usage/instance-details/status.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
7
gitbook/usage/upgrading.md
Normal file
7
gitbook/usage/upgrading.md
Normal 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.
|
||||
Reference in New Issue
Block a user