109 lines
2.8 KiB
Markdown
109 lines
2.8 KiB
Markdown
<p align="center">
|
|
<img src="https://raw.githubusercontent.com/hyper-tuner/cloud-backend/master/public/icon.png" alt="HyperTuner" width="100">
|
|
</p>
|
|
|
|
<h1 align="center">HyperTuner Cloud Backend</h1>
|
|
|
|
<div align="center">
|
|
<p><a href="https://hypertuner.cloud"><strong>hypertuner.cloud</strong></a></p>
|
|
<p><sub>The best way to share your tunes and logs.</sub></p>
|
|
</div>
|
|
|
|
<br/>
|
|
|
|
This is the backend for the [HyperTuner Cloud](https://github.com/hyper-tuner/hypertuner-cloud). It's based on [PocketBase](https://pocketbase.io).
|
|
|
|
## 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](https://github.com/hyper-tuner/cloud-backend/releases) page.
|
|
|
|
```bash
|
|
./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/_/](https://your-instance.com/_/).
|
|
|
|
### Docker image
|
|
|
|
[https://hub.docker.com/r/karniv001/hypertuner-cloud-backend](https://hub.docker.com/r/karniv001/hypertuner-cloud-backend)
|
|
|
|
```bash
|
|
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](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**:
|
|
|
|
```bash
|
|
{APP_URL}/#/auth/email-verification/{TOKEN}
|
|
```
|
|
|
|
- Password reset **ACTION URL**:
|
|
|
|
```bash
|
|
{APP_URL}/#/auth/reset-password-confirmation/{TOKEN}
|
|
```
|
|
|
|
### OAuth2 settings
|
|
|
|
For every OAuth2 provider, you need to set the following redirect URLs:
|
|
|
|
```bash
|
|
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
|
|
|
|
```bash
|
|
go build
|
|
```
|
|
|
|
## Support this project
|
|
|
|
[GitHub Sponsors](https://github.com/sponsors/karniv00l)
|
|
|
|
## Discord server
|
|
|
|
[](https://discord.gg/eaTjzZQNQZ)
|
|
|
|
## License
|
|
|
|
[MIT](https://github.com/hyper-tuner/cloud-backend/blob/master/LICENSE)
|