Self-managing the Aisleron Sync Service

You can run your own instance of the Aisleron Sync Service either on your own hardware or by signing up for a free Supabase cloud instance. Follow the instructions below to set up your instance.

Note that, while every effort will be made to prevent braking changes, backwards compatibility cannot be guaranteed, so it is recommended to always keep your instance updated with the latest available schema.

Prerequisites

Install the Supabase CLI:

macOS / Linux: brew install supabase/tap/supabase
Windows: scoop bucket add supabase [https://github.com/supabase/scoop-bucket.git](https://github.com/supabase/scoop-bucket.git) then scoop install supabase
npm: npm install -g supabase

Common Steps

Clone the repository:

git clone https://github.com/aisleron/aisleron.backend.git

Navigate into the project directory:
```
cd aisleron.backend
```

Option 1: Self-Hosted Instance

For self-hosting, the recommended approach is to use Docker. Refer to Supabase’s instructions for self-hosting with Docker.

Use your PostgreSQL connection string to apply migrations directly to your self-hosted instance.

Push the schema directly to your database URL:

supabase db push --db-url "postgresql://postgres:<PASSWORD>@<HOST>:<PORT>/postgres"

For details on retrieving connection credentials, see the Supabase Direct Connections Documentation.

Option 2: Supabase Cloud

To use Supabase cloud for the backend, sign up for a project at https://supabase.com/.

See Pushing to a remote project for full instructions on how to connect and push database changes to the cloud instance.

Authenticate the CLI:
```
supabase login
```
Link your local directory to your remote project:
```
supabase link --project-ref <YOUR_PROJECT_REF>
```
(Find your Reference ID in Project Settings > General)
Push the schema:
```
supabase db push
```

For more details on CLI migrations, check the Supabase Database Migrations Documentation.

Adding a User Account

To add a user to your Supabase instance, use the Supabase project dashboard.