search

blockshiftnetwork / dokku-pocketbase

Install Pocketbase on Dokku a Heroku Alternative
MIT License
14 stars 8 forks source link
api backend dokku dokku-application dokku-ready heroku pocketbase

readme

Pocketbase Dokku

Pocketbase Logo

Pocketbase is a powerful, open-source backend designed for SaaS and mobile applications, all implemented with a single file.

Pocketbase Documentation

For comprehensive Pocketbase usage and implementation details, visit the Pocketbase Documentation.

Pocketbase Live Demo

Experience the capabilities of Pocketbase through the Live Demo.

How to Install Pocketbase on Dokku

To install Pocketbase on a Dokku server, follow these detailed steps:

  1. Clone the Repository: Download the repository onto your local machine. 
    git clone https://github.com/your-repo/dokku-pocketbase.git
  2. Navigate to Directory: Change to the dokku-pocketbase directory. 
    cd dokku-pocketbase
  3. Create a Dokku App: Set up a new Dokku app named pocketbase on your server. 
    dokku apps:create pocketbase
  4. Ensure Persistent Storage: Create a directory for persistent storage. 
    dokku storage:ensure-directory pocketbase
  5. Mount Storage: Attach the persistent storage to your Pocketbase app. 
    dokku storage:mount pocketbase /var/lib/dokku/data/storage/pocketbase:/app/pb_data
  6. Set Pocketbase Version: (Optional) Specify the Pocketbase version. 
    dokku config:set pocketbase POCKETBASE_VERSION=0.22.4
  7. Add Dokku Remote: Link your local repository to the Dokku remote. 
    git remote add dokku dokku@<YOUR_SERVER_IP>:pocketbase
  8. Deploy Pocketbase: Push your application to the Dokku server. 
    git push dokku main

Pocketbase will now be operational on your server.

Customizing Pocketbase Version

To select a different Pocketbase version, modify the Dockerfile or set the POCKETBASE_VERSION environment variable in your Dokku app.

Upgrading Pocketbase

Upgrade your Pocketbase instance to a new version with these commands:

  1. Add Docker build argument: 
    dokku docker-options:add pocketbase build '--build-arg POCKETBASE_VERSION=0.22.22'
  2. Rebuild your app: 
    dokku ps:rebuild pocketbase

Pocketbase Backups

From version 0.16+, Pocketbase includes built-in backup and restore APIs accessible via the Admin UI (Settings > Backups).

Pocketbase Custom Business Logic

Enhance Pocketbase by writing custom business logic in Go or JavaScript. Use the pb_hooks directory to create a portable backend. Learn more in the Pocketbase as a Framework guide.

Troubleshooting Pocketbase

Consult the Pocketbase Documentation or open an issue on our GitHub repository for any installation or usage problems.

Custom Web and Mobile Solutions

Seeking a custom web application or a bespoke solution for your business? The BlockShift team can assist with:

Contact Us

Ready to start your project? Visit blockshift.us and discover more about our services.

Contributing

We welcome contributions! For details on how to get started, review our Contributing Guide.

License Information

This project is licensed under the MIT License. View the LICENSE file for more details.