mirror of
https://github.com/pockethost/pockethost.git
synced 2025-03-30 15:08:30 +00:00
docs: book conversion
This commit is contained in:
Ben Allfree
parent
9df310303f
commit
aecea67fb1
@ -6,55 +6,39 @@ description: The zero-config, up-in-seconds, hosting platform for PocketBase
|
||||
|
||||
## Overview
|
||||
|
||||
PocketHost ([https://pockethost.io](https://pockethost.io)) is a cloud hosting platform for [PocketBase](https://pocketbase.io). You can use it to instantly provision a PocketBase backend for your latest project.
|
||||
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.
|
||||
|
||||
Features include:
|
||||
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
|
||||
* Access your PocketBase instance using the PocketBase JavaScript SDK as easily as new `PocketBase('https://my-project.pockethost.io')`
|
||||
- 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')`
|
||||
- Run your instance in an ultra-beefy shared environment
|
||||
|
||||
## Focus on your app
|
||||
|
||||
Get a live PocketBase instance in 10 seconds with no backend setup:
|
||||
|
||||
1. Create an account at pockethost.io
|
||||
2. Provision your first PocketBase instance
|
||||
3. Connect from anywhere
|
||||
|
||||
```ts
|
||||
const client = new PocketBase(`https://harvest.pockethost.io`)
|
||||
```
|
||||
|
||||
## Batteries Included
|
||||
|
||||
Here's all the Linux/devops stuff that PocketHost does for you:
|
||||
|
||||
This book contains all the documentation for using, contributing to, and deploying PocketHost.
|
||||
- Email and DKIM+SPF and more
|
||||
- DNS jargon: MX, TXT, CNAME
|
||||
- SSL cert provisioning and management
|
||||
- Storage
|
||||
- Volume mounts
|
||||
- Could computing or VPS deployment
|
||||
- CDN and static asset hosting
|
||||
- Amazon AWS
|
||||
- Lots more - scaling, firewalls, DDoS defense, user security, log rotation, patches, updates, build tools, CPU architectures, multitenancy, on and on
|
||||
|
||||
> tester
|
||||
|
||||
> Loom is a video messaging tool that helps you get your message across through instantly shareable videos.
|
||||
>
|
||||
> With Loom, you can record your camera, microphone, and desktop simultaneously. Your video is then instantly available to share through Loom's patented technology.
|
||||
>
|
||||
> — From the [Loom Docs](https://support.loom.com/hc/en-us/articles/360002158057-What-is-Loom-)
|
||||
|
||||
> The Mailchimp Marketing API provides programmatic access to Mailchimp data and functionality, allowing developers to build custom features to do things like sync email activity and campaign analytics with their database, manage audiences and campaigns, and more.
|
||||
>
|
||||
> — From the [Mailchimp Marketing API docs](https://mailchimp.com/developer/marketing/docs/fundamentals/)
|
||||
|
||||
## Quick links
|
||||
|
||||
{% content-ref url="overview/what-we-do.md" %}
|
||||
[what-we-do.md](overview/what-we-do.md)
|
||||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="overview/our-features.md" %}
|
||||
[our-features.md](overview/our-features.md)
|
||||
{% endcontent-ref %}
|
||||
|
||||
## Get Started
|
||||
|
||||
We've put together some helpful guides for you to get setup with our product quickly and easily.
|
||||
|
||||
{% content-ref url="fundamentals/getting-set-up/" %}
|
||||
[getting-set-up](fundamentals/getting-set-up/)
|
||||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="fundamentals/getting-set-up/setting-permissions.md" %}
|
||||
[setting-permissions.md](fundamentals/getting-set-up/setting-permissions.md)
|
||||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="fundamentals/getting-set-up/inviting-members.md" %}
|
||||
[inviting-members.md](fundamentals/getting-set-up/inviting-members.md)
|
||||
{% endcontent-ref %}
|
||||
This monorepo contains the entire open source stack that powers pockethost.io. You can use it to run your own private or public multitenant platform.
|
||||
|
||||
@ -1,24 +1,33 @@
|
||||
# Table of contents
|
||||
|
||||
* [👋 Welcome to PocketHost](README.md)
|
||||
- [👋 Welcome to PocketHost](README.md)
|
||||
|
||||
## Overview
|
||||
## Development
|
||||
|
||||
* [💡 What we do](overview/what-we-do.md)
|
||||
* [✨ Our Features](overview/our-features.md)
|
||||
- [Running Just the Frontend](development/frontend.md)
|
||||
- [Running Everything](development/full-stack.md)
|
||||
- [Production Deployment](development/production.md)
|
||||
|
||||
## Product Guides
|
||||
## Release History
|
||||
|
||||
* [📪 Making a post](product-guides/making-a-post.md)
|
||||
* [📎 Understanding Projects](product-guides/understanding-projects.md)
|
||||
|
||||
## Fundamentals
|
||||
|
||||
* [🛠 Getting set up](fundamentals/getting-set-up/README.md)
|
||||
* [📝 Setting permissions](fundamentals/getting-set-up/setting-permissions.md)
|
||||
* [🧑 Inviting Members](fundamentals/getting-set-up/inviting-members.md)
|
||||
|
||||
## Use Cases
|
||||
|
||||
* [🎨 For Designers](use-cases/for-designers.md)
|
||||
* [🖥 For Developers](use-cases/for-developers.md)
|
||||
- [Roadmap](development/roadmap.md)
|
||||
- [next](releases/next.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](releases/0.0.1md)
|
||||
|
||||
12
gitbook/development/frontend.md
Normal file
12
gitbook/development/frontend.md
Normal file
@ -0,0 +1,12 @@
|
||||
## Just the frontend (Svelte)
|
||||
|
||||
Just want to work with the UI and frontend?
|
||||
|
||||
```bash
|
||||
git clone git@github.com:benallfree/pockethost.git
|
||||
cd pockethost
|
||||
yarn
|
||||
yarn dev:www
|
||||
```
|
||||
|
||||
That's it. You're in business. Your local Svelte build will talk to the `pockethost.io` mothership and connect to that for all database-related tasks.
|
||||
23
gitbook/development/full-stack.md
Normal file
23
gitbook/development/full-stack.md
Normal file
@ -0,0 +1,23 @@
|
||||
## All our base
|
||||
|
||||
The entire pockethost.io stack can be run locally.
|
||||
|
||||
**Prerequisites**
|
||||
|
||||
- Local SSL wildcard domain - [local domain setup instructions](./docs/local-domain-setup.md)
|
||||
|
||||
**Running in dev mode**
|
||||
|
||||
Note for OS X users: if `pocketbase` does not run, it's probably your [security settings](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac).
|
||||
|
||||
```bash
|
||||
git clone git@github.com:benallfree/pockethost.git
|
||||
cd pockethost
|
||||
yarn
|
||||
cp .env-template .env # modify as needed, if you used `pockethost.test` for your local domain, everything should work
|
||||
scripts/dev.sh
|
||||
open https://pockethost.test
|
||||
open https://pockethost-central.pockethost.test
|
||||
# login: admin@pockethost.test (change in .env)
|
||||
# password: admin@pockethost.test (change in .env)
|
||||
```
|
||||
42
gitbook/development/production.md
Normal file
42
gitbook/development/production.md
Normal file
@ -0,0 +1,42 @@
|
||||
# Production Deployment
|
||||
|
||||
**1. Build**
|
||||
|
||||
```bash
|
||||
git clone git@github.com:benallfree/pockethost.git
|
||||
cd pockethost
|
||||
yarn
|
||||
cp .env-template .env # modify as needed
|
||||
scripts/build.sh
|
||||
```
|
||||
|
||||
**2. Refresh Certbot**
|
||||
|
||||
```bash
|
||||
./scripts/certbot-refresh.sh
|
||||
```
|
||||
|
||||
Then, ensure keys named `fullchain.pem` and `privkey.key` are in `docker/mount/nginx/ssl`.
|
||||
|
||||
**3. Run**
|
||||
|
||||
```bash
|
||||
sudo scripts/pm2.sh
|
||||
sudo pm2 dash
|
||||
sudo open https://pockethost.io
|
||||
```
|
||||
|
||||
**4. Test**
|
||||
|
||||
If all goes well:
|
||||
|
||||
- Update `readme.md` with latest relevant fixes.
|
||||
- Create a new discussion on PocketHost forum
|
||||
- If major release, create announcement on PocketBase forum
|
||||
- Use `yarn version --patch` for patch release and tag with git
|
||||
- Use `scripts/build.sh` to rebuild everything
|
||||
- Use `scripts/pm2.sh` to run in prod mode
|
||||
|
||||
## Updating the max PocketBase semver
|
||||
|
||||
By default, PocketHost will download and run the latest version of PocketBase. If you need to limit or lock the PocketBase versions(s) available, edit the `DAEMON_PB_SEMVER` variable in `.env`.
|
||||
@ -1,33 +0,0 @@
|
||||
# 🛠 Getting set up
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Step1: Creating your organization</summary>
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Step 2: Inviting your team</summary>
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Step 3: Making your first post</summary>
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Step 4: Publishing a post</summary>
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
@ -1,29 +0,0 @@
|
||||
# 🧑 Inviting Members
|
||||
|
||||
{% hint style="info" %}
|
||||
**GitBook tip:** Try out a range of different content types to keep folks engaged and interested in each feature, some content types work for different chunks of information
|
||||
{% endhint %}
|
||||
|
||||
<details>
|
||||
|
||||
<summary>As a Guest User</summary>
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>As an Editor</summary>
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
|
||||
<summary>As an Admin</summary>
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
@ -1,11 +0,0 @@
|
||||
# 📝 Setting permissions
|
||||
|
||||
{% hint style="info" %}
|
||||
**GitBook tip:** your product docs aren't just a reference of all your features, use them to encourage folks to perform certain actions and discover the value in your product.
|
||||
{% endhint %}
|
||||
|
||||
## Permission levels
|
||||
|
||||
There are 4 types of permission levels in the product.
|
||||
|
||||
<table><thead><tr><th width="180">Role</th><th>Capabilities</th></tr></thead><tbody><tr><td>Administrator</td><td>Has all admin privileges</td></tr><tr><td>Editor</td><td>Can edit posts</td></tr><tr><td>Viewer</td><td>Can only view posts</td></tr><tr><td>Guest</td><td>Can only view posts they are inivted to</td></tr></tbody></table>
|
||||
@ -1,17 +0,0 @@
|
||||
# ✨ Our Features
|
||||
|
||||
{% hint style="info" %}
|
||||
**GitBook tip:** A succinct video overview is a great way to introduce folks to your product. Embed a Loom, Vimeo or YouTube video and you're good to go! We love this video from the fine folks at Loom as a perfect example of a succinct feature overview.
|
||||
{% endhint %}
|
||||
|
||||
## Awesome Feature One
|
||||
|
||||
Get amazing things done with awesome feature one. But remember that awesome feature two and three exist too. In fact, Awesome Product is full of awesome features.
|
||||
|
||||
|
||||
|
||||
## Awesome Feature Two
|
||||
|
||||
Get amazing things done with awesome feature two. But remember that awesome feature one and three exist too. In fact, Awesome Product is full of awesome features.
|
||||
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
# 💡 What we do
|
||||
|
||||
{% hint style="info" %}
|
||||
**GitBook tip:** A succinct video overview is a great way to introduce folks to your product. Embed a Loom, Vimeo or YouTube video and you're good to go! We love this video from the fine folks at Loom as a perfect example of a succinct feature overview.
|
||||
{% endhint %}
|
||||
|
||||
## Video overview
|
||||
|
||||
Got 2 minutes? Check out a video overview of our product:
|
||||
|
||||
{% embed url="https://www.loom.com/embed/3bfa83acc9fd41b7b98b803ba9197d90" %}
|
||||
@ -1,13 +0,0 @@
|
||||
# 📪 Making a post
|
||||
|
||||
## Step 1 - Start journalling
|
||||
|
||||
Donec sed odio dui. Curabitur blandit tempus porttitor. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Donec ullamcorper nulla non metus auctor fringilla. Maecenas sed diam eget risus varius blandit sit amet non magna. Aenean lacinia bibendum nulla sed consectetur.
|
||||
|
||||
|
||||
|
||||
## Step 2 - Create Post
|
||||
|
||||
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Maecenas faucibus mollis interdum. Cras mattis consectetur purus sit amet fermentum. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Donec ullamcorper nulla non metus auctor fringilla. Nullam quis risus eget urna mollis ornare vel eu leo. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.
|
||||
|
||||
|
||||
@ -1,21 +0,0 @@
|
||||
# 📎 Understanding Projects
|
||||
|
||||
## How Projects work
|
||||
|
||||
Nullam quis risus eget urna mollis ornare vel eu leo. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Maecenas sed diam eget risus varius blandit sit amet non magna. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Etiam porta sem malesuada magna mollis euismod. Donec id elit non mi porta gravida at eget metus. Donec id elit non mi porta gravida at eget metus.
|
||||
|
||||
### The Basics
|
||||
|
||||
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit.
|
||||
|
||||
Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.
|
||||
|
||||
### Creating a Project
|
||||
|
||||
Nullam quis risus eget urna mollis ornare vel eu leo. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Praesent commodo cursus magna, vel scelerisque nisl consectetur et.
|
||||
|
||||
### Organizing your Projects
|
||||
|
||||
Sed posuere consectetur est at lobortis. Curabitur blandit tempus porttitor. Donec ullamcorper nulla non metus auctor fringilla. Donec sed odio dui.
|
||||
|
||||
Curabitur blandit tempus porttitor. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.
|
||||
3
gitbook/releases/0.0.1.md
Normal file
3
gitbook/releases/0.0.1.md
Normal file
@ -0,0 +1,3 @@
|
||||
**0.0.1**
|
||||
|
||||
- Initial release
|
||||
4
gitbook/releases/0.2.0.md
Normal file
4
gitbook/releases/0.2.0.md
Normal file
@ -0,0 +1,4 @@
|
||||
**0.2.0**
|
||||
|
||||
- 100% dockerized
|
||||
- Completely rewritten daemon proxy that launches PocketBase instances on demand
|
||||
8
gitbook/releases/0.3.0.md
Normal file
8
gitbook/releases/0.3.0.md
Normal file
@ -0,0 +1,8 @@
|
||||
**0.3.0**
|
||||
|
||||
- Improved realtime support in proxy
|
||||
- Updated developer docs
|
||||
- Improved Docker support for dev and prod
|
||||
- Complete UX redesign
|
||||
- Idle/running status for PB instance now shows in green
|
||||
- Ability to run separate versions of PocketBase per instance for custom cases including beta/dev
|
||||
4
gitbook/releases/0.3.1.md
Normal file
4
gitbook/releases/0.3.1.md
Normal file
@ -0,0 +1,4 @@
|
||||
**0.3.1**
|
||||
|
||||
- OpenGraph support
|
||||
- Darkmode enhancements
|
||||
4
gitbook/releases/0.3.2.md
Normal file
4
gitbook/releases/0.3.2.md
Normal file
@ -0,0 +1,4 @@
|
||||
**0.3.2**
|
||||
|
||||
- Migrated PBScript repository to here
|
||||
- Accounts must now be verified before running an instance
|
||||
4
gitbook/releases/0.4.0.md
Normal file
4
gitbook/releases/0.4.0.md
Normal file
@ -0,0 +1,4 @@
|
||||
**0.4.0**
|
||||
|
||||
- PocketBase 0.8 support
|
||||
- Introduced "platforms" concept for version control
|
||||
5
gitbook/releases/0.4.1.md
Normal file
5
gitbook/releases/0.4.1.md
Normal file
@ -0,0 +1,5 @@
|
||||
**0.4.1**
|
||||
|
||||
- Support for 0.7.10 and 0.8.0-rc2
|
||||
- Update to go 1.19.3
|
||||
- Docker build system updates
|
||||
3
gitbook/releases/0.4.2.md
Normal file
3
gitbook/releases/0.4.2.md
Normal file
@ -0,0 +1,3 @@
|
||||
**0.4.2**
|
||||
|
||||
- Runtime metrics now show how many minutes per month an instance has used
|
||||
8
gitbook/releases/0.5.0.md
Normal file
8
gitbook/releases/0.5.0.md
Normal file
@ -0,0 +1,8 @@
|
||||
**0.5.0**
|
||||
|
||||
- Create data backups
|
||||
- Display version near PocketHost logo
|
||||
- Account activation ux enhancements
|
||||
- Password reset feature
|
||||
- Menu ux refresh
|
||||
- PocketBase instance version number now shows on dashboard
|
||||
4
gitbook/releases/0.5.1.md
Normal file
4
gitbook/releases/0.5.1.md
Normal file
@ -0,0 +1,4 @@
|
||||
**0.5.1**
|
||||
|
||||
- fix: 404 after creating instance
|
||||
- fix: SQLite3 build
|
||||
6
gitbook/releases/0.5.2.md
Normal file
6
gitbook/releases/0.5.2.md
Normal file
@ -0,0 +1,6 @@
|
||||
**0.5.2**
|
||||
|
||||
- chore: rc3, rc4, 0.8.0-final support
|
||||
- chore: dedupe yarn
|
||||
- Fix: Account verification needs to hard-redirect
|
||||
- chore: improved bootstrap TS support
|
||||
9
gitbook/releases/0.5.3.md
Normal file
9
gitbook/releases/0.5.3.md
Normal file
@ -0,0 +1,9 @@
|
||||
**0.5.3**
|
||||
|
||||
- fix: incorrect instance information displaying on dashboard details in some cases
|
||||
- fix: more helpful error message when backup fails for nonexistent instance
|
||||
- chore: move version number to base package.json
|
||||
- refactor: logging and async helpers
|
||||
- chore: restore auto-cancellation
|
||||
- chore: rebuild with go 1.19.3 and include in bin name
|
||||
- fix: Disallow backups if data dir doesn't exist
|
||||
5
gitbook/releases/0.5.4.md
Normal file
5
gitbook/releases/0.5.4.md
Normal file
@ -0,0 +1,5 @@
|
||||
**0.5.4**
|
||||
|
||||
- fix: Create Instance cancel button does not work
|
||||
- fix: instances do not stay active for realtime events
|
||||
- chore: support for PocketBase 0.9.0 and 0.9.1
|
||||
4
gitbook/releases/0.5.5.md
Normal file
4
gitbook/releases/0.5.5.md
Normal file
@ -0,0 +1,4 @@
|
||||
**0.5.5**
|
||||
|
||||
- chore: PocketBase 0.9.2 update
|
||||
- chore: PocketBase 0.10.0, 0.10.1 updates
|
||||
4
gitbook/releases/0.5.6.md
Normal file
4
gitbook/releases/0.5.6.md
Normal file
@ -0,0 +1,4 @@
|
||||
**0.5.6**
|
||||
|
||||
- Remove Docker
|
||||
- PocketBase 0.10.4 update
|
||||
6
gitbook/releases/0.5.7.md
Normal file
6
gitbook/releases/0.5.7.md
Normal file
@ -0,0 +1,6 @@
|
||||
**0.5.7**
|
||||
|
||||
- Fix various production errors
|
||||
- Support PATCH and DELETE CORS operations
|
||||
- Add pm2 production support
|
||||
- Implement auto-upgrade feature and semver tagging
|
||||
6
gitbook/releases/0.6.0.md
Normal file
6
gitbook/releases/0.6.0.md
Normal file
@ -0,0 +1,6 @@
|
||||
**0.6.0**
|
||||
|
||||
- FTP support
|
||||
- Cache pocketbase releases
|
||||
- Enhance instance uptime
|
||||
- CORS PUT fix
|
||||
3
gitbook/releases/0.6.1.md
Normal file
3
gitbook/releases/0.6.1.md
Normal file
@ -0,0 +1,3 @@
|
||||
**0.6.1**
|
||||
|
||||
- Fixed semver locking error
|
||||
112
gitbook/releases/0.7.0.md
Normal file
112
gitbook/releases/0.7.0.md
Normal file
@ -0,0 +1,112 @@
|
||||
**0.7.0**
|
||||
|
||||
- PocketHost will now always select and run the latest version of PocketBase for new instances and for the PocketHost central database. This was previously restricted until PocketBase matured more, but we think it is safe now.
|
||||
- Now using native PocketBase migrations to manage PocketHost central database migrations. Roadmap has been updated with task to allow end users to put their PocketBase instance in maintenance mode and run migrations.
|
||||
|
||||
**0.6.1**
|
||||
|
||||
- Fixed semver locking error
|
||||
|
||||
**0.6.0**
|
||||
|
||||
- FTP support
|
||||
- Cache pocketbase releases
|
||||
- Enhance instance uptime
|
||||
- CORS PUT fix
|
||||
|
||||
**0.5.7**
|
||||
|
||||
- Fix various production errors
|
||||
- Support PATCH and DELETE CORS operations
|
||||
- Add pm2 production support
|
||||
- Implement auto-upgrade feature and semver tagging
|
||||
|
||||
**0.5.6**
|
||||
|
||||
- Remove Docker
|
||||
- PocketBase 0.10.4 update
|
||||
|
||||
**0.5.5**
|
||||
|
||||
- chore: PocketBase 0.9.2 update
|
||||
- chore: PocketBase 0.10.0, 0.10.1 updates
|
||||
|
||||
**0.5.4**
|
||||
|
||||
- fix: Create Instance cancel button does not work
|
||||
- fix: instances do not stay active for realtime events
|
||||
- chore: support for PocketBase 0.9.0 and 0.9.1
|
||||
|
||||
**0.5.3**
|
||||
|
||||
- fix: incorrect instance information displaying on dashboard details in some cases
|
||||
- fix: more helpful error message when backup fails for nonexistent instance
|
||||
- chore: move version number to base package.json
|
||||
- refactor: logging and async helpers
|
||||
- chore: restore auto-cancellation
|
||||
- chore: rebuild with go 1.19.3 and include in bin name
|
||||
- fix: Disallow backups if data dir doesn't exist
|
||||
|
||||
**0.5.2**
|
||||
|
||||
- chore: rc3, rc4, 0.8.0-final support
|
||||
- chore: dedupe yarn
|
||||
- Fix: Account verification needs to hard-redirect
|
||||
- chore: improved bootstrap TS support
|
||||
|
||||
**0.5.1**
|
||||
|
||||
- fix: 404 after creating instance
|
||||
- fix: SQLite3 build
|
||||
|
||||
**0.5.0**
|
||||
|
||||
- Create data backups
|
||||
- Display version near PocketHost logo
|
||||
- Account activation ux enhancements
|
||||
- Password reset feature
|
||||
- Menu ux refresh
|
||||
- PocketBase instance version number now shows on dashboard
|
||||
|
||||
**0.4.2**
|
||||
|
||||
- Runtime metrics now show how many minutes per month an instance has used
|
||||
|
||||
**0.4.1**
|
||||
|
||||
- Support for 0.7.10 and 0.8.0-rc2
|
||||
- Update to go 1.19.3
|
||||
- Docker build system updates
|
||||
|
||||
**0.4.0**
|
||||
|
||||
- PocketBase 0.8 support
|
||||
- Introduced "platforms" concept for version control
|
||||
|
||||
**0.3.2**
|
||||
|
||||
- Migrated PBScript repository to here
|
||||
- Accounts must now be verified before running an instance
|
||||
|
||||
**0.3.1**
|
||||
|
||||
- OpenGraph support
|
||||
- Darkmode enhancements
|
||||
|
||||
**0.3.0**
|
||||
|
||||
- Improved realtime support in proxy
|
||||
- Updated developer docs
|
||||
- Improved Docker support for dev and prod
|
||||
- Complete UX redesign
|
||||
- Idle/running status for PB instance now shows in green
|
||||
- Ability to run separate versions of PocketBase per instance for custom cases including beta/dev
|
||||
|
||||
**0.2.0**
|
||||
|
||||
- 100% dockerized
|
||||
- Completely rewritten daemon proxy that launches PocketBase instances on demand
|
||||
|
||||
**0.0.1**
|
||||
|
||||
- Initial release
|
||||
14
gitbook/releases/next.md
Normal file
14
gitbook/releases/next.md
Normal file
@ -0,0 +1,14 @@
|
||||
**next**
|
||||
|
||||
- Feature: Added FAQ section and documentation link
|
||||
- Fix: FTP username link is now properly URLencoded
|
||||
- Fix: static asset requests are routed to PocketBase instance
|
||||
- Fix: requests for instances not ending in `pockethost.io` now rejected
|
||||
- Fix: realtime logging API requests no longer intercepted by PocketBase
|
||||
- Fix: potential timer memory leak
|
||||
- Fix: proper handling of http-proxy error conditions
|
||||
- Chore: various internal error trapping and logging
|
||||
- Fix: FTP now correctly downloads static assets
|
||||
- Fix: FTP now accesses `pb_migrations`
|
||||
- Fix: Secrets CSS light/dark mode fixes
|
||||
- Chore: remove `platform` field from instances and backups
|
||||
@ -1,21 +0,0 @@
|
||||
# 🎨 For Designers
|
||||
|
||||
{% hint style="info" %}
|
||||
**Good to know:** depending on the product you're building, it can be useful to explicitly document use cases. Got a product that can be used by a bunch of people in different ways? Maybe consider splitting it out!
|
||||
{% endhint %}
|
||||
|
||||
## Figma Integrations
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Installing" %}
|
||||
{% embed url="https://www.figma.com/community/plugin/950514102619019349/Automater" %}
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="Configuring" %}
|
||||
Maecenas faucibus mollis interdum. Donec id elit non mi porta gravida at eget metus. Donec ullamcorper nulla non metus auctor fringilla. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="Customizing" %}
|
||||
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
@ -1,23 +0,0 @@
|
||||
# 🖥 For Developers
|
||||
|
||||
{% hint style="info" %}
|
||||
**Good to know:** depending on the product you're building, it can be useful to explicitly document use cases. Got a product that can be used by a bunch of people in different ways? Maybe consider splitting it out!
|
||||
{% endhint %}
|
||||
|
||||
## GitHub Integrations
|
||||
|
||||
Cras mattis consectetur purus sit amet fermentum. Praesent commodo cursus magna, vel scelerisque nisl consectetur et.
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Installing" %}
|
||||
Sed posuere consectetur est at lobortis. Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Aenean lacinia bibendum nulla sed consectetur. Maecenas sed diam eget risus varius blandit sit amet non magna.
|
||||
|
||||
```
|
||||
string | ComponentClass<any, any> | FunctionComponent<any>
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="Second tab" %}
|
||||
Maecenas faucibus mollis interdum. Donec id elit non mi porta gravida at eget metus. Donec ullamcorper nulla non metus auctor fringilla. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
212
readme.md
212
readme.md
@ -43,215 +43,3 @@ This monorepo contains the entire open source stack that powers pockethost.io. Y
|
||||
**Questions?**
|
||||
|
||||
Join us in the discussion area.
|
||||
|
||||
# Development
|
||||
|
||||
## Just the frontend (Svelte)
|
||||
|
||||
Just want to work with the UI and frontend?
|
||||
|
||||
```bash
|
||||
git clone git@github.com:benallfree/pockethost.git
|
||||
cd pockethost
|
||||
yarn
|
||||
yarn dev:www
|
||||
```
|
||||
|
||||
That's it. You're in business. Your local Svelte build will talk to the `pockethost.io` mothership and connect to that for all database-related tasks.
|
||||
|
||||
## All our base
|
||||
|
||||
The entire pockethost.io stack can be run locally.
|
||||
|
||||
**Prerequisites**
|
||||
|
||||
- Local SSL wildcard domain - [local domain setup instructions](./docs/local-domain-setup.md)
|
||||
|
||||
**Running in dev mode**
|
||||
|
||||
Note for OS X users: if `pocketbase` does not run, it's probably your [security settings](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac).
|
||||
|
||||
```bash
|
||||
git clone git@github.com:benallfree/pockethost.git
|
||||
cd pockethost
|
||||
yarn
|
||||
cp .env-template .env # modify as needed, if you used `pockethost.test` for your local domain, everything should work
|
||||
scripts/dev.sh
|
||||
open https://pockethost.test
|
||||
open https://pockethost-central.pockethost.test
|
||||
# login: admin@pockethost.test (change in .env)
|
||||
# password: admin@pockethost.test (change in .env)
|
||||
```
|
||||
|
||||
# Production Deployment
|
||||
|
||||
**1. Build**
|
||||
|
||||
```bash
|
||||
git clone git@github.com:benallfree/pockethost.git
|
||||
cd pockethost
|
||||
yarn
|
||||
cp .env-template .env # modify as needed
|
||||
scripts/build.sh
|
||||
```
|
||||
|
||||
**2. Refresh Certbot**
|
||||
|
||||
```bash
|
||||
./scripts/certbot-refresh.sh
|
||||
```
|
||||
|
||||
Then, ensure keys named `fullchain.pem` and `privkey.key` are in `docker/mount/nginx/ssl`.
|
||||
|
||||
**3. Run**
|
||||
|
||||
```bash
|
||||
sudo scripts/pm2.sh
|
||||
sudo pm2 dash
|
||||
sudo open https://pockethost.io
|
||||
```
|
||||
|
||||
**4. Test**
|
||||
|
||||
If all goes well:
|
||||
|
||||
- Update `readme.md` with latest relevant fixes.
|
||||
- Create a new discussion on PocketHost forum
|
||||
- If major release, create announcement on PocketBase forum
|
||||
- Use `yarn version --patch` for patch release and tag with git
|
||||
- Use `scripts/build.sh` to rebuild everything
|
||||
- Use `scripts/pm2.sh` to run in prod mode
|
||||
|
||||
## Updating the max PocketBase semver
|
||||
|
||||
By default, PocketHost will download and run the latest version of PocketBase. If you need to limit or lock the PocketBase versions(s) available, edit the `DAEMON_PB_SEMVER` variable in `.env`.
|
||||
|
||||
# Release History
|
||||
|
||||
**next**
|
||||
|
||||
- Feature: Added FAQ section and documentation link
|
||||
- Fix: FTP username link is now properly URLencoded
|
||||
- Fix: static asset requests are routed to PocketBase instance
|
||||
- Fix: requests for instances not ending in `pockethost.io` now rejected
|
||||
- Fix: realtime logging API requests no longer intercepted by PocketBase
|
||||
- Fix: potential timer memory leak
|
||||
- Fix: proper handling of http-proxy error conditions
|
||||
- Chore: various internal error trapping and logging
|
||||
- Fix: FTP now correctly downloads static assets
|
||||
- Fix: FTP now accesses `pb_migrations`
|
||||
- Fix: Secrets CSS light/dark mode fixes
|
||||
- Chore: remove `platform` field from instances and backups
|
||||
|
||||
**0.7.0**
|
||||
|
||||
- PocketHost will now always select and run the latest version of PocketBase for new instances and for the PocketHost central database. This was previously restricted until PocketBase matured more, but we think it is safe now.
|
||||
- Now using native PocketBase migrations to manage PocketHost central database migrations. Roadmap has been updated with task to allow end users to put their PocketBase instance in maintenance mode and run migrations.
|
||||
|
||||
**0.6.1**
|
||||
|
||||
- Fixed semver locking error
|
||||
|
||||
**0.6.0**
|
||||
|
||||
- FTP support
|
||||
- Cache pocketbase releases
|
||||
- Enhance instance uptime
|
||||
- CORS PUT fix
|
||||
|
||||
**0.5.7**
|
||||
|
||||
- Fix various production errors
|
||||
- Support PATCH and DELETE CORS operations
|
||||
- Add pm2 production support
|
||||
- Implement auto-upgrade feature and semver tagging
|
||||
|
||||
**0.5.6**
|
||||
|
||||
- Remove Docker
|
||||
- PocketBase 0.10.4 update
|
||||
|
||||
**0.5.5**
|
||||
|
||||
- chore: PocketBase 0.9.2 update
|
||||
- chore: PocketBase 0.10.0, 0.10.1 updates
|
||||
|
||||
**0.5.4**
|
||||
|
||||
- fix: Create Instance cancel button does not work
|
||||
- fix: instances do not stay active for realtime events
|
||||
- chore: support for PocketBase 0.9.0 and 0.9.1
|
||||
|
||||
**0.5.3**
|
||||
|
||||
- fix: incorrect instance information displaying on dashboard details in some cases
|
||||
- fix: more helpful error message when backup fails for nonexistent instance
|
||||
- chore: move version number to base package.json
|
||||
- refactor: logging and async helpers
|
||||
- chore: restore auto-cancellation
|
||||
- chore: rebuild with go 1.19.3 and include in bin name
|
||||
- fix: Disallow backups if data dir doesn't exist
|
||||
|
||||
**0.5.2**
|
||||
|
||||
- chore: rc3, rc4, 0.8.0-final support
|
||||
- chore: dedupe yarn
|
||||
- Fix: Account verification needs to hard-redirect
|
||||
- chore: improved bootstrap TS support
|
||||
|
||||
**0.5.1**
|
||||
|
||||
- fix: 404 after creating instance
|
||||
- fix: SQLite3 build
|
||||
|
||||
**0.5.0**
|
||||
|
||||
- Create data backups
|
||||
- Display version near PocketHost logo
|
||||
- Account activation ux enhancements
|
||||
- Password reset feature
|
||||
- Menu ux refresh
|
||||
- PocketBase instance version number now shows on dashboard
|
||||
|
||||
**0.4.2**
|
||||
|
||||
- Runtime metrics now show how many minutes per month an instance has used
|
||||
|
||||
**0.4.1**
|
||||
|
||||
- Support for 0.7.10 and 0.8.0-rc2
|
||||
- Update to go 1.19.3
|
||||
- Docker build system updates
|
||||
|
||||
**0.4.0**
|
||||
|
||||
- PocketBase 0.8 support
|
||||
- Introduced "platforms" concept for version control
|
||||
|
||||
**0.3.2**
|
||||
|
||||
- Migrated PBScript repository to here
|
||||
- Accounts must now be verified before running an instance
|
||||
|
||||
**0.3.1**
|
||||
|
||||
- OpenGraph support
|
||||
- Darkmode enhancements
|
||||
|
||||
**0.3.0**
|
||||
|
||||
- Improved realtime support in proxy
|
||||
- Updated developer docs
|
||||
- Improved Docker support for dev and prod
|
||||
- Complete UX redesign
|
||||
- Idle/running status for PB instance now shows in green
|
||||
- Ability to run separate versions of PocketBase per instance for custom cases including beta/dev
|
||||
|
||||
**0.2.0**
|
||||
|
||||
- 100% dockerized
|
||||
- Completely rewritten daemon proxy that launches PocketBase instances on demand
|
||||
|
||||
**0.0.1**
|
||||
|
||||
- Initial release
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user