cloud-backend/README.md

HyperTuner Cloud Backend

hypertuner.cloud

_{The best way to share your tunes and logs.}

This is the backend for the HyperTuner Cloud. It's based on PocketBase.

This repository

• the source code of the HyperTuner Cloud backend that extends PocketBase.
• database schema
• configurations
• deployment scripts / Docker and docker compose files
• migration scripts and guides

Setting up your instance

Use provider Docker image or just grab the binary from the Releases page.

./cloud-backend serve

This will create pb_data directory where all the data will be stored (SQLite, uploaded files and metadata).

Now you can access the admin UI at: https://your-instance.com/_/.

Docker image

https://hub.docker.com/r/karniv001/hypertuner-cloud-backend

docker pull karniv001/hypertuner-cloud-backend:1.3.6

Upgrading

Warning Some versions will contain breaking changes!

If you are upgrading from a previous version, please read the UPGRADE.md file.

Application name and URL

Located in admin UI: Settings -> Application.

• Application name - the name of your application
• Application URL - the URL of your frontend application

Mail settings

Located in the admin UI: Settings -> Mailer settings.

• Verification email ACTION URL:

{APP_URL}/#/auth/email-verification/{TOKEN}

• Password reset ACTION URL:

{APP_URL}/#/auth/reset-password-confirmation/{TOKEN}

OAuth2 settings

For every OAuth2 provider, you need to set the following redirect URLs:

https://{FRONTEND-URL}/?redirect=oauth&provider=google
https://{FRONTEND-URL}/?redirect=oauth&provider=github
https://{FRONTEND-URL}/?redirect=oauth&provider=facebook

Loading schema

Copy/load pb_schema.json to Settings -> Sync -> Import collections in the admin UI.

Health check

You can use the /api/health endpoint to check if the application is up and running.

Building from source

go build

Support this project

GitHub Sponsors

Discord server

License

MIT